From b16eb3e41ebab7216ebd6a300cc16f049d605b03 Mon Sep 17 00:00:00 2001 From: Takashi Tamura Date: Fri, 28 May 2021 14:10:59 +0900 Subject: [PATCH] Fix doc for unwatch() and close(). --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9456fca0..8ec3deb5 100644 --- a/README.md +++ b/README.md @@ -255,8 +255,8 @@ Available events: `add`, `addDir`, `change`, `unlink`, `unlinkDir`, `ready`, Additionally `all` is available which gets emitted with the underlying event name and path for every event other than `ready`, `raw`, and `error`. `raw` is internal, use it carefully. * `.unwatch(path / paths)`: Stop watching files, directories, or glob patterns. -Takes an array of strings or just one string. Use with `await` to ensure bugs don't happen. -* `.close()`: **async** Removes all listeners from watched files. Asynchronous, returns Promise. +Takes an array of strings or just one string. +* `.close()`: **async** Removes all listeners from watched files. Asynchronous, returns Promise. Use with `await` to ensure bugs don't happen. * `.getWatched()`: Returns an object representing all the paths on the file system being watched by this `FSWatcher` instance. The object's keys are all the directories (using absolute paths unless the `cwd` option was used), and the