Skip to content

doc: clarify possible eventType values in fs.watch #53041

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+1 −1
Open

doc: clarify possible eventType values in fs.watch #53041

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3b86ea1
doc: clarify possible `eventType` values in `fs.watch`
benmccann May 18, 2024
35bd8af
Update fs.md
benmccann May 18, 2024
e2251b3
Update fs.md
benmccann May 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1774,7 +1774,7 @@ added:
* `signal` {AbortSignal} An {AbortSignal} used to signal when the watcher
should stop.
* Returns: {AsyncIterator} of objects with the properties:
* `eventType` {string} The type of change
* `eventType` {string} The type of change: `'change'` or `'rename'`
* `filename` {string|Buffer|null} The name of the file changed.

Returns an async iterator that watches for changes on `filename`, where `filename`
Expand Down