Skip to content
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

Jump to bottom

doc: add description of autoAllocateChunkSize in ReadableStream #48004

Merged
merged 1 commit into from
Jun 24, 2023
Merged

doc: add description of autoAllocateChunkSize in ReadableStream #48004

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 4 additions & 1 deletion doc/api/webstreams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,10 @@ added: v16.5.0
* Returns: A promise fulfilled with `undefined`.
* `type` {string} Must be `'bytes'` or `undefined`.
* `autoAllocateChunkSize` {number} Used only when `type` is equal to
`'bytes'`.
`'bytes'`. When set to a non-zero value a view buffer is automatically
allocated to `ReadableByteStreamController.byobRequest`. When not set
one must use stream's internal queues to transfer data via the default
reader `ReadableStreamDefaultReader`.
* `strategy` {Object}
* `highWaterMark` {number} The maximum internal queue size before backpressure
is applied.
Expand Down