Skip to content

Commit

Permalink
doc: include context on .toWeb() parameters
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
debadree25 authored and danielleadams committed Apr 5, 2023
1 parent c8974d6 commit e6db6be
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions doc/api/stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -2976,8 +2976,14 @@ added: v17.0.0
* `streamReadable` {stream.Readable}
* `options` {Object}
* `strategy` {Object}
* `highWaterMark` {number}
* `size` {Function}
* `highWaterMark` {number} The maximum internal queue size (of the created
`ReadableStream`) before backpressure is applied in reading from the given
`stream.Readable`. If no value is provided, it will be taken from the
given `stream.Readable`.
* `size` {Function} A function that size of the given chunk of data.
If no value is provided, the size will be `1` for all the chunks.
* `chunk` {any}
* Returns: {number}
* Returns: {ReadableStream}

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

0 comments on commit e6db6be

Please sign in to comment.