Commit 1b3a25e
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 c0fcad3 commit 1b3a25e
1 file changed
Lines changed: 8 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3003,8 +3003,14 @@ added: v17.0.0 | |||
| 3003 | 3003 | * `streamReadable` {stream.Readable} | |
| 3004 | 3004 | * `options` {Object} | |
| 3005 | 3005 | * `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} | ||
| 3008 | 3014 | * Returns: {ReadableStream} | |
| 3009 | 3015 | ||
| 3010 | 3016 | ### `stream.Writable.fromWeb(writableStream[, options])` | |
0 commit comments