diff options
| author | Juan José Arboleda <soyjuanarbol@gmail.com> | 2020-03-27 09:17:54 +0300 |
|---|---|---|
| committer | Beth Griggs <Bethany.Griggs@uk.ibm.com> | 2020-04-07 18:30:12 +0300 |
| commit | 49c15063783a69f05039d1716d616d02f6bd8b32 (patch) | |
| tree | 5cf3bdf1cf8ff07467b9a93c90b20fe22d0a8970 /doc/api | |
| parent | f23b8789859a711e0a93c49e3d5762889cbe56b8 (diff) | |
doc: clarify docs fs.watch exception may be emitted
Fixes: https://github.com/nodejs/node/issues/29894
PR-URL: https://github.com/nodejs/node/pull/32513
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/fs.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md index a0dff1c3008..5bf3dcacde1 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -3884,10 +3884,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. |