Skip to content

Commit f18b287

Browse files
debadree25ruyadorno
authored andcommittedSep 12, 2023
doc: add description of autoAllocateChunkSize in ReadableStream
Refs: https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream/ReadableStream PR-URL: #48004 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
1 parent f2ce8e0 commit f18b287

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed
 

‎doc/api/webstreams.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,10 @@ added: v16.5.0
124124
* Returns: A promise fulfilled with `undefined`.
125125
* `type` {string} Must be `'bytes'` or `undefined`.
126126
* `autoAllocateChunkSize` {number} Used only when `type` is equal to
127-
`'bytes'`.
127+
`'bytes'`. When set to a non-zero value a view buffer is automatically
128+
allocated to `ReadableByteStreamController.byobRequest`. When not set
129+
one must use stream's internal queues to transfer data via the default
130+
reader `ReadableStreamDefaultReader`.
128131
* `strategy` {Object}
129132
* `highWaterMark` {number} The maximum internal queue size before backpressure
130133
is applied.

0 commit comments

Comments
 (0)
Please sign in to comment.