Skip to content

Commit 607ff34

Browse files
authored
doc: include context on .toWeb() parameters
Refs: #46347 PR-URL: #46617 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Harshitha K P <harshitha014@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent f32aa19 commit 607ff34

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
@@ -3005,8 +3005,14 @@ added: v17.0.0
30053005
* `streamReadable` {stream.Readable}
30063006
* `options` {Object}
30073007
* `strategy` {Object}
3008-
* `highWaterMark` {number}
3009-
* `size` {Function}
3008+
* `highWaterMark` {number} The maximum internal queue size (of the created
3009+
`ReadableStream`) before backpressure is applied in reading from the given
3010+
`stream.Readable`. If no value is provided, it will be taken from the
3011+
given `stream.Readable`.
3012+
* `size` {Function} A function that size of the given chunk of data.
3013+
If no value is provided, the size will be `1` for all the chunks.
3014+
* `chunk` {any}
3015+
* Returns: {number}
30103016
* Returns: {ReadableStream}
30113017

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

0 commit comments

Comments
 (0)