Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

streams: make the pipeline callback mandatory #21054

Closed
wants to merge 2 commits into from
+14 −24
Closed

streams: make the pipeline callback mandatory #21054

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9a29f3
streams: make the pipeline callback mandatory
BridgeAR May 31, 2018
3bd86d1
fixup
BridgeAR May 31, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
fixup
@BridgeAR
BridgeAR committed May 31, 2018

Verified

This commit was signed with the committer’s verified signature. The key has expired.
BridgeAR Ruben Bridgewater
GPG key ID: F07496B3EB3C1762
Expired
Verified
Learn about vigilant mode
commit 3bd86d17303d8385922e7ac6bc7fb1a03b63bb07
6 changes: 3 additions & 3 deletions doc/api/stream.md
View file
Original file line number Diff line number Diff line change
@@ -1340,14 +1340,14 @@ run().catch(console.error);
rs.resume(); // drain the stream
```

### stream.pipeline(...streams[, callback])
### stream.pipeline(...streams, callback)
<!-- YAML
added: v10.0.0
-->

* `...streams` {Stream} Two or more streams to pipe between.
* `callback` {Function} A callback function that takes an optional error
argument.
* `callback` {Function} Called when the pipeline is fully done.
* `err` {Error}

A module method to pipe between streams forwarding errors and properly cleaning
up and provide a callback when the pipeline is complete.