Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Fuma2514 wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −2
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1557,6 +1557,12 @@

<!-- YAML
added: v0.9.4
changes:
- version: v26.0.0
pr-url: https://github.com/nodejs/node/pull/60441

Check warning on line 1562 in doc/api/stream.md

View workflow job for this annotation

GitHub Actions / lint-pr-url 

pr-url doesn't match the URL of the current PR.
description: When called without a `size` argument, `readable.read()` now
returns one buffered chunk per call instead of draining the
entire internal buffer.
-->

* `size` {number} Optional argument to specify how much data to read.
Expand All @@ -1573,8 +1579,12 @@
the stream has ended, in which case all of the data remaining in the internal
buffer will be returned.

If the `size` argument is not specified, all of the data contained in the
internal buffer will be returned.
If the `size` argument is not specified, `readable.read()` returns the next
buffered chunk, or the next object in object mode. If the entire internal
buffer is needed in a single call, `readable.read(readable.readableLength)`
returns all currently buffered data; because data can be buffered internally
without an explicit `push()`, some cases may additionally require calling
`readable.read(0)` first to ensure all buffered data is available.

The `size` argument must be less than or equal to 1 GiB.

Expand Down
Loading