From e391cca2e8ece4bbc40bd96ec5263ba35ddd08ea Mon Sep 17 00:00:00 2001 From: Bartosz Sosnowski Date: Tue, 10 Mar 2020 16:02:19 +0100 Subject: [PATCH 1/2] doc: expand fs.watch caveats Document Windows specific fs.watch caveats. Fixes: https://github.com/nodejs/node/issues/31702 --- doc/api/fs.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index a70f56f3c922af..c0de8d6be35eb3 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -3773,6 +3773,9 @@ The recursive option is only supported on macOS and Windows. An `ERR_FEATURE_UNAVAILABLE_ON_PLATFORM` exception will be thrown when the option is used on a platform that does not support it. +On Windows no events will be emitted if the watched directory is moved or +renamed. If the watched directory is deleted `EPERM` error will be reported. + #### Availability From 9a780473242c21428d0a7de72eaa6691c39686e4 Mon Sep 17 00:00:00 2001 From: Bartosz Sosnowski Date: Wed, 11 Mar 2020 12:02:42 +0100 Subject: [PATCH 2/2] fixup: pr review suggestions --- doc/api/fs.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index c0de8d6be35eb3..be46b022e6953e 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -3773,8 +3773,8 @@ The recursive option is only supported on macOS and Windows. An `ERR_FEATURE_UNAVAILABLE_ON_PLATFORM` exception will be thrown when the option is used on a platform that does not support it. -On Windows no events will be emitted if the watched directory is moved or -renamed. If the watched directory is deleted `EPERM` error will be reported. +On Windows, no events will be emitted if the watched directory is moved or +renamed. An `EPERM` error is reported when the watched directory is deleted. #### Availability