doc: fix fsPromises.watch overflow value#64605
Open
mradbourne wants to merge 1 commit into
Open
Conversation
Updates the fsPromises.watch overflow option description to use 'error' instead of 'throw', which matches the implementation. Signed-off-by: Matt Radbourne <1254508+mradbourne@users.noreply.github.com>
nodejs-github-bot
added
doc
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
2 participants
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.
Updates the
fsPromises.watchoverflowoption description to use 'error' instead of 'throw', which matches the implementation.Currently the
overflowoption for this function can be either 'ignore' or 'error', however the documentation specifies 'throw' instead of 'error'. This PR brings the docs in-line with the current behaviour.Relevant to the docs for v26, v25, v24, v22.