Skip to content

Commit

Permalink
doc: update stream.pipeline() signature
Browse files Browse the repository at this point in the history
The  `...transforms` parameter is optional.

Refs: https://github.com/nodejs/node/blob/0875837417/lib/internal/streams/pipeline.js#L130-L132
Refs: https://github.com/nodejs/node/blob/e559842188/doc/api/stream.md#streams-compatibility-with-async-generators-and-async-iterators

PR-URL: #31789
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Yongsheng Zhang <zyszys98@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
  • Loading branch information
vsemozhetbyt authored and MylesBorins committed Mar 4, 2020
1 parent a1eb471 commit ba3f7ff
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/api/stream.md
Expand Up @@ -1555,7 +1555,7 @@ const cleanup = finished(rs, (err) => {
});
```

### `stream.pipeline(source, ...transforms, destination, callback)`
### `stream.pipeline(source[, ...transforms], destination, callback)`
<!-- YAML
added: v10.0.0
changes:
Expand Down

0 comments on commit ba3f7ff

Please sign in to comment.