Skip to content

doc: add pipeline and finished to stream/promises doc #45832

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

Merged
nodejs-github-bot merged 8 commits into from
Dec 15, 2022
Merged

doc: add pipeline and finished to stream/promises doc #45832

Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9175ce3
doc: add stream/promises pipeline and finished to doc
marco-ippolito Dec 12, 2022
f4336cb
doc: fixed correct return type
marco-ippolito Dec 12, 2022
a02e238
doc: improved documentation
marco-ippolito Dec 13, 2022
5559f0d
doc: typo removed >
marco-ippolito Dec 13, 2022
b545d80
doc: top level await and typo
marco-ippolito Dec 15, 2022
083825e
doc: fix setImmediate
marco-ippolito Dec 15, 2022
50bf959
fix: period instead of :
marco-ippolito Dec 15, 2022
c930116
doc: newline
marco-ippolito Dec 15, 2022
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
28 changes: 28 additions & 0 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,34 @@ functions for streams that return `Promise` objects rather than using
callbacks. The API is accessible via `require('node:stream/promises')`
or `require('node:stream').promises`.

### `stream.pipeline(source[, ...transforms], destination, options)`

### `stream.pipeline(streams, options)`
Comment thread
marco-ippolito marked this conversation as resolved.
Resolved

* `streams` {Stream\[]|Iterable\[]|AsyncIterable\[]|Function\[]}
* `source` {Stream|Iterable|AsyncIterable|Function}
* Returns: {Promise<AsyncIterable>}
Comment thread
marco-ippolito marked this conversation as resolved.
Resolved
* `...transforms` {Stream|Function}
* `source` {AsyncIterable}
* Returns: {Promise<AsyncIterable>}
Comment thread
marco-ippolito marked this conversation as resolved.
Resolved
* `destination` {Stream|Function}
* `source` {AsyncIterable}
* Returns: {Promise<AsyncIterable>}
Comment thread
marco-ippolito marked this conversation as resolved.
Resolved
* `options` {Object}
* `signal` {AbortSignal}
* `end` {boolean}
* Returns: {Promise<void>}
Comment thread
marco-ippolito marked this conversation as resolved.
Resolved

### `stream.finished(stream, options)`
Comment thread
marco-ippolito marked this conversation as resolved.
Resolved

* `stream` {Stream}
* `options` {Object}
* `error` {boolean|undefined}
* `readable` {boolean|undefined}
* `writable` {boolean|undefined}
* `signal`: {AbortSignal|undefined}
* Returns: {Promise<void>}
Comment thread
marco-ippolito marked this conversation as resolved.
Resolved

### Object mode

All streams created by Node.js APIs operate exclusively on strings and `Buffer`
Expand Down