Skip to content

Commit

Permalink
doc: clarify docs fs.watch exception may be emitted
Browse files Browse the repository at this point in the history
Fixes: #29894

PR-URL: #32513
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
  • Loading branch information
juanarbol authored and targos committed Apr 11, 2020
1 parent b567a63 commit 5c70db4
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -3893,10 +3893,10 @@ to be notified of filesystem changes.
* On Aix systems, this feature depends on [`AHAFS`][], which must be enabled.

If the underlying functionality is not available for some reason, then
`fs.watch` will not be able to function. For example, watching files or
directories can be unreliable, and in some cases impossible, on network file
systems (NFS, SMB, etc), or host file systems when using virtualization software
such as Vagrant, Docker, etc.
`fs.watch()` will not be able to function and may thrown an exception.
For example, watching files or directories can be unreliable, and in some
cases impossible, on network file systems (NFS, SMB, etc) or host file systems
when using virtualization software such as Vagrant or Docker.

It is still possible to use `fs.watchFile()`, which uses stat polling, but
this method is slower and less reliable.
Expand Down

0 comments on commit 5c70db4

Please sign in to comment.