From e6db6bedf7144a7e116ed4e3e5c2e60ae765311f Mon Sep 17 00:00:00 2001 From: Debadree Chatterjee Date: Thu, 23 Feb 2023 00:26:50 +0530 Subject: [PATCH] doc: include context on .toWeb() parameters Refs: https://github.com/nodejs/node/issues/46347 PR-URL: https://github.com/nodejs/node/pull/46617 Reviewed-By: Antoine du Hamel Reviewed-By: Harshitha K P Reviewed-By: James M Snell --- doc/api/stream.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/api/stream.md b/doc/api/stream.md index 9f3340b7bd04da..b72262d521afad 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -2976,8 +2976,14 @@ added: v17.0.0 * `streamReadable` {stream.Readable} * `options` {Object} * `strategy` {Object} - * `highWaterMark` {number} - * `size` {Function} + * `highWaterMark` {number} The maximum internal queue size (of the created + `ReadableStream`) before backpressure is applied in reading from the given + `stream.Readable`. If no value is provided, it will be taken from the + given `stream.Readable`. + * `size` {Function} A function that size of the given chunk of data. + If no value is provided, the size will be `1` for all the chunks. + * `chunk` {any} + * Returns: {number} * Returns: {ReadableStream} ### `stream.Writable.fromWeb(writableStream[, options])`