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.

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

Merged
merged 1 commit into from
Oct 19, 2023

Conversation

himself65
Copy link
Member

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem. labels Oct 16, 2023
@himself65 himself65 force-pushed the himself65/1014/docs-update branch 2 times, most recently from 407468c to 3cfa55c Compare October 16, 2023 22:53
@himself65 himself65 force-pushed the himself65/1014/docs-update branch from 01d7a5e to 10789bf Compare October 16, 2023 23:58
@@ -2833,7 +2836,7 @@ changes:
> 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

@himself65 himself65 added the fast-track PRs that do not need to wait for 48 hours to land. label Oct 17, 2023
@github-actions
Copy link
Contributor

Fast-track has been requested by @himself65. Please 👍 to approve.

@H4ad H4ad added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Oct 18, 2023
@himself65 himself65 added the commit-queue Add this label to land a pull request using GitHub Actions. label Oct 18, 2023
@nodejs-github-bot nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Oct 18, 2023
@nodejs-github-bot
Copy link
Collaborator

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/.ncu
https://github.com/nodejs/node/actions/runs/6565350236

@himself65 himself65 added commit-queue Add this label to land a pull request using GitHub Actions. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels Oct 18, 2023
@nodejs-github-bot nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Oct 18, 2023
@nodejs-github-bot
Copy link
Collaborator

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/.ncu
https://github.com/nodejs/node/actions/runs/6566227376

@himself65 himself65 added commit-queue Add this label to land a pull request using GitHub Actions. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels Oct 18, 2023
@nodejs-github-bot nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Oct 18, 2023
@nodejs-github-bot
Copy link
Collaborator

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/.ncu
https://github.com/nodejs/node/actions/runs/6567293855

@himself65 himself65 added commit-queue Add this label to land a pull request using GitHub Actions. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels Oct 19, 2023
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Oct 19, 2023
@nodejs-github-bot nodejs-github-bot merged commit c016397 into nodejs:main Oct 19, 2023
40 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in c016397

@himself65 himself65 deleted the himself65/1014/docs-update branch October 19, 2023 01:05
targos pushed a commit that referenced this pull request Oct 23, 2023
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>
alexfernandez pushed a commit to alexfernandez/node that referenced this pull request Nov 1, 2023
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>
targos pushed a commit that referenced this pull request Nov 11, 2023
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. fast-track PRs that do not need to wait for 48 hours to land. stream Issues and PRs related to the stream subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants