Skip to content

Commit

Permalink
doc: expand fs.watch caveats
Browse files Browse the repository at this point in the history
Document Windows specific fs.watch caveats.

Fixes: nodejs#31702
  • Loading branch information
bzoz committed Mar 10, 2020
1 parent c933cbf commit e391cca
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -3773,6 +3773,9 @@ The recursive option is only supported on macOS and Windows.
An `ERR_FEATURE_UNAVAILABLE_ON_PLATFORM` exception will be thrown
when the option is used on a platform that does not support it.

On Windows no events will be emitted if the watched directory is moved or
renamed. If the watched directory is deleted `EPERM` error will be reported.

#### Availability

<!--type=misc-->
Expand Down

0 comments on commit e391cca

Please sign in to comment.