Skip to content

Commit

Permalink
doc: add streams to the pipeline function signature
Browse files Browse the repository at this point in the history
PR-URL: #34153
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
rickyes authored and MylesBorins committed Jul 16, 2020
1 parent 9f0bf5c commit ab6b786
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doc/api/stream.md
Expand Up @@ -1598,6 +1598,7 @@ const cleanup = finished(rs, (err) => {
```

### `stream.pipeline(source[, ...transforms], destination, callback)`
### `stream.pipeline(streams, callback)`
<!-- YAML
added: v10.0.0
changes:
Expand All @@ -1612,6 +1613,7 @@ changes:
which are expected to emit `'close'`.
-->

* `streams` {Stream[]|Iterable[]|AsyncIterable[]|Function[]}
* `source` {Stream|Iterable|AsyncIterable|Function}
* Returns: {Iterable|AsyncIterable}
* `...transforms` {Stream|Function}
Expand Down

0 comments on commit ab6b786

Please sign in to comment.