Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: clarify docs fs.watch exception may be emitted #32513

Closed
wants to merge 3 commits into from
Closed

doc: clarify docs fs.watch exception may be emitted #32513

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
39c8126
doc: clarify docs fs.watch exception may be emitted
juanarbol Mar 27, 2020
69d061b
fixup
juanarbol Mar 27, 2020
9c5e8fa
fixup
juanarbol Mar 31, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3815,10 +3815,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 (may an exception will be thrown).
juanarbol marked this conversation as resolved.
Show resolved Hide resolved
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
addaleax marked this conversation as resolved.
Show resolved Hide resolved
when using virtualization software such as Vagrant, Docker, etc.
addaleax marked this conversation as resolved.
Show resolved Hide resolved

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