doc: fix fs.watch overflow option accepted value - #65174
Closed
arhxam wants to merge 1 commit into
Closed
Conversation
The `overflow` option for `fs.watch()` and `fsPromises.watch()` is documented as accepting `'ignore'` or `'throw'`, but the implementation validates against `['ignore', 'error']` in lib/internal/fs/watchers.js. Passing the documented `'throw'` value therefore throws `ERR_INVALID_ARG_VALUE`. Update the documentation to use `'error'`, the value that is actually accepted. Signed-off-by: Arham Wani <arhamwani765@gmail.com>
daeyeon
approved these changes
Aug 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The
overflowoption forfs.watch()/fsPromises.watch()isdocumented as accepting
'ignore'or'throw', but the implementationvalidates the value against
['ignore', 'error']inlib/internal/fs/watchers.js:So a user who follows the docs and passes
overflow: 'throw'gets anerror instead of the described behavior:
The value that is actually accepted,
'error', throwsERR_FS_WATCH_QUEUE_OVERFLOWon overflow, which matches the documented"throw an exception" behavior. This updates the documentation to use
'error'. Documentation-only change;'throw'and'error'are thesame length so no reflowing is needed.