Commit e6db6be
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
1 file changed
Lines changed: 8 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2976,8 +2976,14 @@ added: v17.0.0 | |||
| 2976 | 2976 | * `streamReadable` {stream.Readable} | |
| 2977 | 2977 | * `options` {Object} | |
| 2978 | 2978 | * `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} | ||
| 2981 | 2987 | * Returns: {ReadableStream} | |
| 2982 | 2988 | ||
| 2983 | 2989 | ### `stream.Writable.fromWeb(writableStream[, options])` | |
0 commit comments