Skip to content

Commit 21c3685

Browse files
juanarboltargos
authored andcommitted
doc: clarify docs fs.watch exception may be emitted
Fixes: #29894 PR-URL: #32513 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
1 parent c3d91eb commit 21c3685

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

doc/api/fs.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -3777,10 +3777,10 @@ to be notified of filesystem changes.
37773777
* On Aix systems, this feature depends on [`AHAFS`][], which must be enabled.
37783778

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

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

0 commit comments

Comments
 (0)