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

Jump to bottom

docs: update api stream.compose #50206

Merged
merged 1 commit into from
Oct 19, 2023
+4 −1
Merged

docs: update api stream.compose #50206

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
5 changes: 4 additions & 1 deletion doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2823,6 +2823,9 @@
<!-- YAML
added: v16.9.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/50187

Check warning on line 2827 in doc/api/stream.md

View workflow job for this annotation

GitHub Actions / lint-pr-url 

pr-url doesn't match the URL of the current PR.
description: Added support for stream class.
- version:
- v19.8.0
- v18.16.0
Expand All @@ -2833,7 +2836,7 @@
> Stability: 1 - `stream.compose` is experimental.

* `streams` {Stream\[]|Iterable\[]|AsyncIterable\[]|Function\[]|
ReadableStream\[]|WritableStream\[]|TransformStream\[]}
ReadableStream\[]|WritableStream\[]|TransformStream\[]|Duplex\[]|Function}
Copy link

Choose a reason for hiding this comment

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

How about additionally including various types of streams such as Transform, PassThrough, FileReadStream, FileWriteStream, and Socket, allowing for more comprehensive coverage of stream types?

Suggested change
ReadableStream\[]|WritableStream\[]|TransformStream\[]|Duplex\[]|Function}
ReadableStream\[]|WritableStream\[]|TransformStream\[]|Duplex\[]|Function|Transform\[]|PassThrough\[]| FileReadStream\[]|FileWriteStream\[]|Socket\[]}

Copy link
Member Author

Choose a reason for hiding this comment

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

I think other document doesn't have such classes. Also I think current classes are top-level class, we don't need add all of the builtin class stuff

* Returns: {stream.Duplex}

Combines two or more streams into a `Duplex` stream that writes to the
Expand Down