Skip to content

doc: fix fsPromises.watch overflow value - #64605

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
mradbourne:fix-fs-watch-overflow-docs
Aug 28, 2026
Merged

doc: fix fsPromises.watch overflow value#64605
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
mradbourne:fix-fs-watch-overflow-docs

Conversation

@mradbourne

Copy link
Copy Markdown
Contributor

Updates the fsPromises.watch overflow option description to use 'error' instead of 'throw', which matches the implementation.

Currently the overflow option 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.

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 nodejs-github-bot added doc Issues and PRs related to Node.js documentation. fs Issues and PRs related to file-system APIs and the fs module. labels Jul 19, 2026
@trivikr trivikr added author ready PRs with CI started, the required approvals, and no outstanding review comments. commit-queue PRs queued for automated landing through the Commit Queue. labels Aug 24, 2026
@nodejs-github-bot
nodejs-github-bot merged commit eb0b944 into nodejs:main Aug 28, 2026
17 checks passed
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in eb0b944

@nodejs-github-bot nodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 28, 2026
aduh95 pushed a commit that referenced this pull request Aug 29, 2026
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>
PR-URL: #64605
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
aduh95 pushed a commit that referenced this pull request Sep 3, 2026
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>
PR-URL: #64605
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author ready PRs with CI started, the required approvals, and no outstanding review comments. doc Issues and PRs related to Node.js documentation. fs Issues and PRs related to file-system APIs and the fs module.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants