Skip to content

doc: correct default highWaterMark values - #64617

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
umuoy1:doc-correct-write-stream-high-water-mark
Aug 5, 2026
Merged

doc: correct default highWaterMark values#64617
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
umuoy1:doc-correct-write-stream-high-water-mark

Conversation

@umuoy1

Copy link
Copy Markdown
Contributor

The fs.createWriteStream() and filehandle.createWriteStream() docs still listed a fixed 16 KiB default. These streams inherit the default byte-stream highWaterMark, which is 64 KiB on non-Windows platforms and 16 KiB on Windows.

Update the fs docs to reference stream.getDefaultHighWaterMark() and clarify the platform-specific defaults in the stream docs.

@nodejs-github-botnodejs-github-bot added the doc Issues and PRs related to the documentations. label Jul 20, 2026
@umuoy1

Copy link
Copy Markdown
ContributorAuthor

Gentle ping @nodejs/documentation — could someone take a look?

Comment threaddoc/api/stream.md
@legendecaslegendecas added the stream Issues and PRs related to the stream subsystem. label Aug 2, 2026
@legendecaslegendecas added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue Add this label to land a pull request using GitHub Actions. labels Aug 4, 2026
@nodejs-github-botnodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Aug 4, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator
Commit Queue failed
- Loading data for nodejs/node/pull/64617
✔ Done loading data for nodejs/node/pull/64617
----------------------------------- PR info ------------------------------------
Title doc: correct default highWaterMark values (#64617)
Author Yilong Li <burningdian@gmail.com> (@umuoy1)
Branch umuoy1:doc-correct-write-stream-high-water-mark -> nodejs:main
Labels doc, stream, author ready
Commits 3
- doc: correct default highWaterMark values
- Merge branch 'main' into doc-correct-write-stream-high-water-mark
- doc: add highWaterMark change history
Committers 2
- umuoy1 <burningdian@gmail.com>
- GitHub <noreply@github.com>
PR-URL: https://github.com/nodejs/node/pull/64617
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/64617
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
--------------------------------------------------------------------------------
ℹ This PR was created on Mon, 20 Jul 2026 09:05:52 GMT
✔ Approvals: 1
✔ - Chengzhong Wu (@legendecas) (TSC): https://github.com/nodejs/node/pull/64617#pullrequestreview-4849836694
✔ Last GitHub CI successful
ℹ Green GitHub CI is sufficient
--------------------------------------------------------------------------------
✔ No git cherry-pick in progress
✔ No git am in progress
✔ No git rebase in progress
--------------------------------------------------------------------------------
- Bringing origin/main up to date...
From https://github.com/nodejs/node
* branch main -> FETCH_HEAD
✔ origin/main is now up-to-date
- Downloading patch for 64617
From https://github.com/nodejs/node
* branch refs/pull/64617/merge -> FETCH_HEAD
✔ Fetched commits as 3fc98b802ec2..7ef5129b53f1
--------------------------------------------------------------------------------
Auto-merging doc/api/fs.md
CONFLICT (content): Merge conflict in doc/api/fs.md
Auto-merging doc/api/stream.md
error: could not apply 1f4ac06ce5... doc: correct default highWaterMark values
hint: After resolving the conflicts, mark them with
hint: "git add/rm <pathspec>", then run
hint: "git cherry-pick --continue".
hint: You can instead skip this commit with "git cherry-pick --skip".
hint: To abort and get back to the state before "git cherry-pick",
hint: run "git cherry-pick --abort".
hint: Disable this message with "git config set advice.mergeConflict false"
✘ Failed to apply patches
https://github.com/nodejs/node/actions/runs/30921412978

@umuoy1
umuoy1force-pushed the doc-correct-write-stream-high-water-mark branch 2 times, most recently from c6b651a to da753d5CompareAugust 4, 2026 17:48
File write streams inherit the default byte-stream highWaterMark.
The fixed 16 KiB value became stale when that default changed.
Also document the Windows-specific byte-stream default.
Signed-off-by: umuoy1 <burningdian@gmail.com>
@umuoy1
umuoy1force-pushed the doc-correct-write-stream-high-water-mark branch from da753d5 to de1246cCompareAugust 4, 2026 18:11
@legendecaslegendecas added commit-queue Add this label to land a pull request using GitHub Actions. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels Aug 4, 2026
@nodejs-github-botnodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Aug 4, 2026
@trivikrtrivikr added the commit-queue Add this label to land a pull request using GitHub Actions. label Aug 5, 2026
@nodejs-github-botnodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Aug 5, 2026
@nodejs-github-bot
nodejs-github-bot merged commit e535675 into nodejs:mainAug 5, 2026
22 checks passed
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in e535675

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.docIssues and PRs related to the documentations.streamIssues and PRs related to the stream subsystem.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@umuoy1@nodejs-github-bot@legendecas@trivikr