From e90dadf13ec83ff2f923bbcb004c478a773cb961 Mon Sep 17 00:00:00 2001 From: Debadree Chatterjee Date: Sun, 25 Jun 2023 01:53:23 +0530 Subject: [PATCH] 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 Reviewed-By: Luigi Pinca --- doc/api/webstreams.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/api/webstreams.md b/doc/api/webstreams.md index 1ff5b7e6b73950..a413beb7174fd4 100644 --- a/doc/api/webstreams.md +++ b/doc/api/webstreams.md @@ -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.