Skip to content

Commit 1b3a25e

Browse files
debadree25targos
authored andcommitted
doc: include context on .toWeb() parameters
Refs: #46347 PR-URL: #46617 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Harshitha K P <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent c0fcad3 commit 1b3a25e

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

doc/api/stream.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -3003,8 +3003,14 @@ added: v17.0.0
30033003
* `streamReadable` {stream.Readable}
30043004
* `options` {Object}
30053005
* `strategy` {Object}
3006-
* `highWaterMark` {number}
3007-
* `size` {Function}
3006+
* `highWaterMark` {number} The maximum internal queue size (of the created
3007+
`ReadableStream`) before backpressure is applied in reading from the given
3008+
`stream.Readable`. If no value is provided, it will be taken from the
3009+
given `stream.Readable`.
3010+
* `size` {Function} A function that size of the given chunk of data.
3011+
If no value is provided, the size will be `1` for all the chunks.
3012+
* `chunk` {any}
3013+
* Returns: {number}
30083014
* Returns: {ReadableStream}
30093015

30103016
### `stream.Writable.fromWeb(writableStream[, options])`

0 commit comments

Comments
 (0)