-
Notifications
You must be signed in to change notification settings - Fork 30.1k
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.
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
docs: update api stream.compose
#50206
docs: update api stream.compose
#50206
Conversation
407468c
to
3cfa55c
Compare
01d7a5e
to
10789bf
Compare
@@ -2833,7 +2836,7 @@ changes: | |||
> Stability: 1 - `stream.compose` is experimental. | |||
|
|||
* `streams` {Stream\[]|Iterable\[]|AsyncIterable\[]|Function\[]| | |||
ReadableStream\[]|WritableStream\[]|TransformStream\[]} | |||
ReadableStream\[]|WritableStream\[]|TransformStream\[]|Duplex\[]|Function} |
There was a problem hiding this comment.
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?
ReadableStream\[]|WritableStream\[]|TransformStream\[]|Duplex\[]|Function} | |
ReadableStream\[]|WritableStream\[]|TransformStream\[]|Duplex\[]|Function|Transform\[]|PassThrough\[]| FileReadStream\[]|FileWriteStream\[]|Socket\[]} |
There was a problem hiding this comment.
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
Fast-track has been requested by @himself65. Please 👍 to approve. |
Commit Queue failed- Loading data for nodejs/node/pull/50206 ✔ Done loading data for nodejs/node/pull/50206 ----------------------------------- PR info ------------------------------------ Title docs: update api `stream.compose` (#50206) Author Alex Yang (@himself65) Branch himself65:himself65/1014/docs-update -> nodejs:main Labels doc, stream, fast-track, author ready Commits 1 - doc: update api `stream.compose` Committers 1 - Alex Yang PR-URL: https://github.com/nodejs/node/pull/50206 Refs: https://github.com/nodejs/node/pull/50187/files#r1361215879 Reviewed-By: Moshe Atlow Reviewed-By: Vinícius Lourenço Claro Cardoso ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/50206 Refs: https://github.com/nodejs/node/pull/50187/files#r1361215879 Reviewed-By: Moshe Atlow Reviewed-By: Vinícius Lourenço Claro Cardoso -------------------------------------------------------------------------------- ℹ This PR was created on Mon, 16 Oct 2023 22:50:21 GMT ✔ Approvals: 2 ✔ - Moshe Atlow (@MoLow) (TSC): https://github.com/nodejs/node/pull/50206#pullrequestreview-1682063884 ✔ - Vinícius Lourenço Claro Cardoso (@H4ad): https://github.com/nodejs/node/pull/50206#pullrequestreview-1683690155 ℹ This PR is being fast-tracked ✘ This PR needs to wait 3 more hours to land (or 0 hours if there is 1 more approval (👍) of the fast-track request from collaborators). ✔ Last GitHub CI successful ℹ Green GitHub CI is sufficient -------------------------------------------------------------------------------- ✔ Aborted `git node land` session in /home/runner/work/node/node/.ncuhttps://github.com/nodejs/node/actions/runs/6565350236 |
Commit Queue failed- Loading data for nodejs/node/pull/50206 ✔ Done loading data for nodejs/node/pull/50206 ----------------------------------- PR info ------------------------------------ Title docs: update api `stream.compose` (#50206) Author Alex Yang (@himself65) Branch himself65:himself65/1014/docs-update -> nodejs:main Labels doc, stream, fast-track, author ready Commits 1 - doc: update api `stream.compose` Committers 1 - Alex Yang PR-URL: https://github.com/nodejs/node/pull/50206 Refs: https://github.com/nodejs/node/pull/50187/files#r1361215879 Reviewed-By: Moshe Atlow Reviewed-By: Vinícius Lourenço Claro Cardoso ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/50206 Refs: https://github.com/nodejs/node/pull/50187/files#r1361215879 Reviewed-By: Moshe Atlow Reviewed-By: Vinícius Lourenço Claro Cardoso -------------------------------------------------------------------------------- ℹ This PR was created on Mon, 16 Oct 2023 22:50:21 GMT ✔ Approvals: 2 ✔ - Moshe Atlow (@MoLow) (TSC): https://github.com/nodejs/node/pull/50206#pullrequestreview-1682063884 ✔ - Vinícius Lourenço Claro Cardoso (@H4ad): https://github.com/nodejs/node/pull/50206#pullrequestreview-1683690155 ℹ This PR is being fast-tracked ✘ This PR needs to wait 2 more hours to land (or 0 hours if there is 1 more approval (👍) of the fast-track request from collaborators). ✔ Last GitHub CI successful ℹ Green GitHub CI is sufficient -------------------------------------------------------------------------------- ✔ Aborted `git node land` session in /home/runner/work/node/node/.ncuhttps://github.com/nodejs/node/actions/runs/6566227376 |
Commit Queue failed- Loading data for nodejs/node/pull/50206 ✔ Done loading data for nodejs/node/pull/50206 ----------------------------------- PR info ------------------------------------ Title docs: update api `stream.compose` (#50206) Author Alex Yang (@himself65) Branch himself65:himself65/1014/docs-update -> nodejs:main Labels doc, stream, fast-track, author ready Commits 1 - doc: update api `stream.compose` Committers 1 - Alex Yang PR-URL: https://github.com/nodejs/node/pull/50206 Refs: https://github.com/nodejs/node/pull/50187/files#r1361215879 Reviewed-By: Moshe Atlow Reviewed-By: Vinícius Lourenço Claro Cardoso ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/50206 Refs: https://github.com/nodejs/node/pull/50187/files#r1361215879 Reviewed-By: Moshe Atlow Reviewed-By: Vinícius Lourenço Claro Cardoso -------------------------------------------------------------------------------- ℹ This PR was created on Mon, 16 Oct 2023 22:50:21 GMT ✔ Approvals: 2 ✔ - Moshe Atlow (@MoLow) (TSC): https://github.com/nodejs/node/pull/50206#pullrequestreview-1682063884 ✔ - Vinícius Lourenço Claro Cardoso (@H4ad): https://github.com/nodejs/node/pull/50206#pullrequestreview-1683690155 ℹ This PR is being fast-tracked ✘ This PR needs to wait 21 more minutes to land (or 0 hours if there is 1 more approval (👍) of the fast-track request from collaborators). ✔ Last GitHub CI successful ℹ Green GitHub CI is sufficient -------------------------------------------------------------------------------- ✔ Aborted `git node land` session in /home/runner/work/node/node/.ncuhttps://github.com/nodejs/node/actions/runs/6567293855 |
Landed in c016397 |
PR-URL: #50206 Refs: https://github.com/nodejs/node/pull/50187/files#r1361215879 Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br>
PR-URL: nodejs#50206 Refs: https://github.com/nodejs/node/pull/50187/files#r1361215879 Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br>
PR-URL: #50206 Refs: https://github.com/nodejs/node/pull/50187/files#r1361215879 Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br>
Upstream: #50187
Refs: https://github.com/nodejs/node/pull/50187/files#r1361215879