We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent c0fcad3 commit 1b3a25eCopy full SHA for 1b3a25e
doc/api/stream.md
@@ -3003,8 +3003,14 @@ added: v17.0.0
3003
* `streamReadable` {stream.Readable}
3004
* `options` {Object}
3005
* `strategy` {Object}
3006
- * `highWaterMark` {number}
3007
- * `size` {Function}
+ * `highWaterMark` {number} The maximum internal queue size (of the created
+ `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}
3014
* Returns: {ReadableStream}
3015
3016
### `stream.Writable.fromWeb(writableStream[, options])`
0 commit comments