Skip to content

Commit

Permalink
doc: add description of autoAllocateChunkSize in ReadableStream
Browse files Browse the repository at this point in the history
Refs: https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream/ReadableStream
PR-URL: nodejs#48004
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
  • Loading branch information
debadree25 authored and Ceres6 committed Aug 14, 2023
1 parent ddcb045 commit 30df0a4
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion doc/api/webstreams.md
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

0 comments on commit 30df0a4

Please sign in to comment.