From 21c368562397b9e73b6727b837aba317cce5f710 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Jos=C3=A9=20Arboleda?= Date: Fri, 27 Mar 2020 01:17:54 -0500 Subject: [PATCH] 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 Reviewed-By: Trivikram Kamat --- doc/api/fs.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index 196581141dbce6..c3a94862b5ce30 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -3777,10 +3777,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.