Skip to content

doc: copyedit fs doc #3097

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Trott wants to merge 2 commits into from
Closed

doc: copyedit fs doc #3097

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
44cbdf9
doc: copyedit fs doc
Trott Sep 28, 2015
a921dc9
doc: further copyediting to fs doc
Trott Sep 28, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions doc/api/fs.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -633,9 +633,7 @@ the event.
The `fs.watch` API is not 100% consistent across platforms, and is
unavailable in some situations.

The recursive option is currently supported on OS X and Windows. Only FSEvents
supports this type of file watching so it is unlikely any additional platforms
will be added soon.
The recursive option is only supported on OS X and Windows.

#### Availability

Expand All @@ -662,11 +660,10 @@ less reliable.

<!--type=misc-->

Providing `filename` argument in the callback is not supported
on every platform (currently it's only supported on Linux and Windows). Even
on supported platforms `filename` is not always guaranteed to be provided.
Therefore, don't assume that `filename` argument is always provided in the
callback, and have some fallback logic if it is null.
Providing `filename` argument in the callback is only supported on Linux and
Windows. Even on supported platforms, `filename` is not always guaranteed to
be provided. Therefore, don't assume that `filename` argument is always
provided in the callback, and have some fallback logic if it is null.

fs.watch('somedir', function (event, filename) {
console.log('event is: ' + event);
Expand Down