doc: add description of autoAllocateChunkSize in ReadableStream

Refs: https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream/ReadableStream
PR-URL: https://github.com/nodejs/node/pull/48004
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
This commit is contained in:
Debadree Chatterjee 2023-06-25 01:53:23 +05:30 committed by GitHub
parent 7eafd2f7e8
commit e90dadf13e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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.