Skip to content

Commit e6db6be

Browse files
debadree25danielleadams
authored andcommitted
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 c8974d6 commit e6db6be

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

doc/api/stream.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2976,8 +2976,14 @@ added: v17.0.0
29762976
* `streamReadable` {stream.Readable}
29772977
* `options` {Object}
29782978
* `strategy` {Object}
2979-
* `highWaterMark` {number}
2980-
* `size` {Function}
2979+
* `highWaterMark` {number} The maximum internal queue size (of the created
2980+
`ReadableStream`) before backpressure is applied in reading from the given
2981+
`stream.Readable`. If no value is provided, it will be taken from the
2982+
given `stream.Readable`.
2983+
* `size` {Function} A function that size of the given chunk of data.
2984+
If no value is provided, the size will be `1` for all the chunks.
2985+
* `chunk` {any}
2986+
* Returns: {number}
29812987
* Returns: {ReadableStream}
29822988

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

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy