diff options
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/stream.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md index 014b2f68b3..09ff2c02b1 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -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. |