Commit 912cae6
doc: clarify eventType in fs.watch
'rename' is confusing, and it's not clear what "they" refers to.
Fixes: #9082
PR-URL: #9318
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>1 parent 9a526cb commit 912cae6
1 file changed
Lines changed: 6 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1703,8 +1703,12 @@ The listener callback gets two arguments `(eventType, filename)`. `eventType` i | |||
| 1703 | 1703 | `'rename'` or `'change'`, and `filename` is the name of the file which triggered | |
| 1704 | 1704 | the event. | |
| 1705 | 1705 | ||
| 1706 | - Please note the listener callback is attached to the `'change'` event | ||
| 1707 | - fired by [`fs.FSWatcher`][], but they are not the same thing. | ||
| 1706 | + Note that on most platforms, `'rename'` is emitted whenever a filename appears | ||
| 1707 | + or disappears in the directory. | ||
| 1708 | + | ||
| 1709 | + Also note the listener callback is attached to the `'change'` event fired by | ||
| 1710 | + [`fs.FSWatcher`][], but it is not the same thing as the `'change'` value of | ||
| 1711 | + `eventType`. | ||
| 1708 | 1712 | ||
| 1709 | 1713 | ### Caveats | |
| 1710 | 1714 | ||
0 commit comments