Skip to content

Commit 928166c

Browse files
Trottrvagg
authored andcommitted
doc: copyedit fs.watch() information
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: #3097 Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Saúl Ibarra Corretgé <[email protected]>
1 parent 7a58157 commit 928166c

File tree

1 file changed

+5
-8
lines changed

1 file changed

+5
-8
lines changed

doc/api/fs.markdown

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -633,9 +633,7 @@ the event.
633633
The `fs.watch` API is not 100% consistent across platforms, and is
634634
unavailable in some situations.
635635

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

640638
#### Availability
641639

@@ -662,11 +660,10 @@ less reliable.
662660

663661
<!--type=misc-->
664662

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

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

0 commit comments

Comments
 (0)