From b209a6e2715f098985a24cde9023b4aa3b5a25c5 Mon Sep 17 00:00:00 2001 From: Nikolai Vavilov Date: Thu, 27 Oct 2016 20:49:21 +0300 Subject: [PATCH] doc: clarify eventType in fs.watch 'rename' is confusing, and it's not clear what "they" refers to. Fixes: https://github.com/nodejs/node/issues/9082 PR-URL: https://github.com/nodejs/node/pull/9318 Reviewed-By: Rich Trott Reviewed-By: James M Snell Reviewed-By: Roman Reiss --- doc/api/fs.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index 5ad3d7ce52..20c0a38b96 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1701,8 +1701,12 @@ The listener callback gets two arguments `(eventType, filename)`. `eventType` i `'rename'` or `'change'`, and `filename` is the name of the file which triggered the event. -Please note the listener callback is attached to the `'change'` event -fired by [`fs.FSWatcher`][], but they are not the same thing. +Note that on most platforms, `'rename'` is emitted whenever a filename appears +or disappears in the directory. + +Also note the listener callback is attached to the `'change'` event fired by +[`fs.FSWatcher`][], but it is not the same thing as the `'change'` value of +`eventType`. ### Caveats