Skip to content

doc: update readable.read() for v26 one-chunk behaviour - #67341

Open
Fuma2514 wants to merge 1 commit into
nodejs:mainfrom
Fuma2514:doc-stream-read-v26
Open

Fuma2514 wants to merge 1 commit into
nodejs:mainfrom
Fuma2514:doc-stream-read-v26

Conversation

@Fuma2514

@Fuma2514 Fuma2514 commented Nov 8, 2026

Copy link
Copy Markdown

Fixes #67323.

Since #60441 (v26.0.0, semver-major), readable.read() without a size argument returns one buffered chunk per call, but doc/api/stream.md still said it returns "all of the data contained in the internal buffer". This PR:

Docs only, no code changes. Verified that no other part of the example text depends on the old wording; the while (null !== (chunk = readable.read())) loop example remains correct under the new behaviour (it now drains one chunk per iteration until null).

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to Node.js documentation. stream Issues and PRs related to Node.js streams. labels Nov 8, 2026
@github-actions

github-actions Bot commented Nov 8, 2026

Copy link
Copy Markdown
Contributor

Welcome to Node.js, and thank you for your first contribution!

Before review, please take a moment to read:

Please make sure every commit is signed off. For a first pull request, GitHub Actions require collaborator approval and Jenkins CI must be started by a collaborator or triager, so an initial wait is normal.

Caution

AgentScan found account activity patterns that may be consistent with automation. This is a heuristic, not proof that this pull request was opened by an agent or violates policy. AI-assisted contributions are permitted, but automated tooling must not open pull requests without advance approval, and contributors must personally understand, test, verify, and take responsibility for every submitted change. See the AgentScan analysis, AI use policy, and automation policy for additional context.

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

Labels

agentscan:automated-account doc Issues and PRs related to Node.js documentation. stream Issues and PRs related to Node.js streams.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc: readable.read() still documents pre-v26 behaviour (returns all buffered data when size is omitted)

2 participants