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: #31702

PR-URL: #32176
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Masashi Hirano <shisama07@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
bzoz authored and addaleax committed Mar 13, 2020
1 parent edb3ffb commit 1a844a6
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 @@ -3796,6 +3796,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. An `EPERM` error is reported when the watched directory is deleted.

#### Availability

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

0 comments on commit 1a844a6

Please sign in to comment.