GeezerVison is showing github.com — doc: clarify docs fs.watch exception may be emitted · nodejs/node@5c70db4
File tree
Expand file treeCollapse file tree
Open diff view settings
Expand file treeCollapse file tree
Open diff view settings
Collapse file
Copy file name to clipboardExpand all lines: doc/api/fs.md +4-4Lines changed: 4 additions & 4 deletions - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -3893,10 +3893,10 @@ to be notified of filesystem changes. |
3893 | 3893 | * On Aix systems, this feature depends on [`AHAFS`][], which must be enabled. |
3894 | 3894 |
|
3895 | 3895 | If the underlying functionality is not available for some reason, then |
3896 | | -`fs.watch` will not be able to function. For example, watching files or |
3897 | | -directories can be unreliable, and in some cases impossible, on network file |
3898 | | -systems (NFS, SMB, etc), or host file systems when using virtualization software |
3899 | | -such as Vagrant, Docker, etc. |
| 3896 | +`fs.watch()` will not be able to function and may thrown an exception. |
| 3897 | +For example, watching files or directories can be unreliable, and in some |
| 3898 | +cases impossible, on network file systems (NFS, SMB, etc) or host file systems |
| 3899 | +when using virtualization software such as Vagrant or Docker. |
3900 | 3900 |
|
3901 | 3901 | It is still possible to use `fs.watchFile()`, which uses stat polling, but |
3902 | 3902 | this method is slower and less reliable. |
|