1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: copyedit fs.watch() information

Browse Source 
Removed "Only FSEvents supports this type of file watching so it is
unlikely any additional platforms will be added soon."

Per @saghul, "FSEvents" refers to the OSX API, but since we added
Windows support it may not be  unlikely that we add more.

PR-URL: https://github.com/nodejs/node/pull/3097
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
This commit is contained in:
Rich Trott 2015-09-27 20:08:43 -07:00
parent f1d27d27f5
commit 0e4b772d6c
1 changed files with 5 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/api/fs.markdown
View File

@ -633,9 +633,7 @@ the event.
The `fs.watch` API is not 100% consistent across platforms, and is The `fs.watch` API is not 100% consistent across platforms, and is
unavailable in some situations. unavailable in some situations.
The recursive option is currently supported on OS X and Windows. Only FSEvents The recursive option is only supported on OS X and Windows.
supports this type of file watching so it is unlikely any additional platforms
will be added soon.
#### Availability #### Availability
@ -662,11 +660,10 @@ less reliable.
<!--type=misc--> <!--type=misc-->
Providing `filename` argument in the callback is not supported Providing `filename` argument in the callback is only supported on Linux and
on every platform (currently it's only supported on Linux and Windows). Even Windows. Even on supported platforms, `filename` is not always guaranteed to
on supported platforms `filename` is not always guaranteed to be provided. be provided. Therefore, don't assume that `filename` argument is always
Therefore, don't assume that `filename` argument is always provided in the provided in the callback, and have some fallback logic if it is null.
callback, and have some fallback logic if it is null.
fs.watch('somedir', function (event, filename) { fs.watch('somedir', function (event, filename) {
console.log('event is: ' + event); console.log('event is: ' + event);