Skip to content

Commit 145ed32

Browse files
authored
doc: include webstreams in finished() and Duplex.from() parameters
PR-URL: #46312 Refs: #46190 Refs: #46205 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
1 parent b8b92ca commit 145ed32

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

doc/api/stream.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2603,6 +2603,9 @@ further errors except from `_destroy()` may be emitted as `'error'`.
26032603
<!-- YAML
26042604
added: v10.0.0
26052605
changes:
2606+
- version: v19.5.0
2607+
pr-url: https://github.com/nodejs/node/pull/46205
2608+
description: Added support for `ReadableStream` and `WritableStream`.
26062609
- version: v15.11.0
26072610
pr-url: https://github.com/nodejs/node/pull/37354
26082611
description: The `signal` option was added.
@@ -2622,7 +2625,9 @@ changes:
26222625
finished before the call to `finished(stream, cb)`.
26232626
-->
26242627

2625-
* `stream` {Stream} A readable and/or writable stream.
2628+
* `stream` {Stream|ReadableStream|WritableStream}
2629+
2630+
A readable and/or writable stream/webstream.
26262631

26272632
* `options` {Object}
26282633
* `error` {boolean} If set to `false`, then a call to `emit('error', err)` is
@@ -3031,10 +3036,16 @@ added: v17.0.0
30313036

30323037
<!-- YAML
30333038
added: v16.8.0
3039+
changes:
3040+
- version: v19.5.0
3041+
pr-url: https://github.com/nodejs/node/pull/46190
3042+
description: The `src` argument can now be a `ReadableStream` or
3043+
`WritableStream`.
30343044
-->
30353045

30363046
* `src` {Stream|Blob|ArrayBuffer|string|Iterable|AsyncIterable|
3037-
AsyncGeneratorFunction|AsyncFunction|Promise|Object}
3047+
AsyncGeneratorFunction|AsyncFunction|Promise|Object|
3048+
ReadableStream|WritableStream}
30383049

30393050
A utility method for creating duplex streams.
30403051

@@ -3054,6 +3065,8 @@ A utility method for creating duplex streams.
30543065
`writable` into `Stream` and then combines them into `Duplex` where the
30553066
`Duplex` will write to the `writable` and read from the `readable`.
30563067
* `Promise` converts into readable `Duplex`. Value `null` is ignored.
3068+
* `ReadableStream` converts into readable `Duplex`.
3069+
* `WritableStream` converts into writable `Duplex`.
30573070
* Returns: {stream.Duplex}
30583071

30593072
If an `Iterable` object containing promises is passed as an argument,

0 commit comments

Comments
 (0)