Skip to content

doc: correct default highWaterMark values - #64617

Open
umuoy1 wants to merge 3 commits into
nodejs:mainfrom
umuoy1:doc-correct-write-stream-high-water-mark
Open

doc: correct default highWaterMark values#64617
umuoy1 wants to merge 3 commits into
nodejs:mainfrom
umuoy1:doc-correct-write-stream-high-water-mark

Conversation

@umuoy1

@umuoy1 umuoy1 commented Jul 20, 2026

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.

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>
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Jul 20, 2026
@umuoy1

umuoy1 commented Aug 1, 2026

Copy link
Copy Markdown
Contributor Author

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

Comment thread doc/api/stream.md
@legendecas legendecas added the stream Issues and PRs related to the stream subsystem. label Aug 2, 2026
@legendecas legendecas added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Aug 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants