Skip to content

doc: add streams to the pipeline function signature #34153

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

Closed
rickyes wants to merge 1 commit into from
Closed

doc: add streams to the pipeline function signature #34153

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
doc: add streams to the pipeline function signature
  • Loading branch information
@rickyes
rickyes committed Jul 1, 2020
commit 73f06a6bd7b4b0181af650c19ea154845bfcb7fe
2 changes: 2 additions & 0 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1596,6 +1596,7 @@ const cleanup = finished(rs, (err) => {
```

### `stream.pipeline(source[, ...transforms], destination, callback)`
### `stream.pipeline(streams, callback)`
Comment on lines 1598 to +1599

@jasnell jasnell Jul 3, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This way of referencing multiple signatures is just awful, fwiw. Eventually, we really do need to go back and completely rearchitect our doc structure.

<!-- YAML
added: v10.0.0
changes:
Expand All @@ -1610,6 +1611,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