docs: update api `stream.compose` by himself65 · Pull Request #50206 · nodejs/node

himself65 · 2023-10-16T22:50:21Z

Upstream: #50187
Refs: https://github.com/nodejs/node/pull/50187/files#r1361215879

Mifrill · 2023-10-17T15:21:52Z

doc/api/stream.md


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


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\[]}

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

github-actions · 2023-10-17T20:49:32Z

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

nodejs-github-bot · 2023-10-18T19:01:33Z

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

nodejs-github-bot · 2023-10-18T20:31:12Z

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

nodejs-github-bot · 2023-10-18T22:29:12Z

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

nodejs-github-bot · 2023-10-19T01:00:07Z

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>

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 force-pushed the himself65/1014/docs-update branch 2 times, most recently from 407468c to 3cfa55c Compare October 16, 2023 22:53

doc: update api stream.compose

10789bf

himself65 force-pushed the himself65/1014/docs-update branch from 01d7a5e to 10789bf Compare October 16, 2023 23:58

MoLow approved these changes Oct 17, 2023

View reviewed changes

Mifrill reviewed Oct 17, 2023

View reviewed changes

himself65 added the fast-track PRs that do not need to wait for 48 hours to land. label Oct 17, 2023

H4ad approved these changes Oct 18, 2023

View reviewed changes

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 added the commit-queue Add this label to land a pull request using GitHub Actions. label Oct 18, 2023

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

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 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

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 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

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 removed the commit-queue Add this label to land a pull request using GitHub Actions. label Oct 19, 2023

nodejs-github-bot merged commit c016397 into nodejs:main Oct 19, 2023

himself65 deleted the himself65/1014/docs-update branch October 19, 2023 01:05

targos mentioned this pull request Oct 23, 2023

v21.1.0 release proposal #50335

Merged

targos mentioned this pull request Nov 12, 2023

v20.10.0 release proposal #50682

Merged

juanarbol mentioned this pull request Dec 6, 2023

2023-12-06, N|Solid v5.0.1 Iron Release nodesource/nsolid#41

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: update api `stream.compose`#50206

docs: update api `stream.compose`#50206
nodejs-github-bot merged 1 commit intonodejs:mainfrom
himself65:himself65/1014/docs-update

himself65 commented Oct 16, 2023

Uh oh!

Mifrill Oct 17, 2023

Uh oh!

himself65 Oct 17, 2023

Uh oh!

github-actions bot commented Oct 17, 2023

Uh oh!

nodejs-github-bot commented Oct 18, 2023

Uh oh!

nodejs-github-bot commented Oct 18, 2023

Uh oh!

nodejs-github-bot commented Oct 18, 2023

Uh oh!

nodejs-github-bot commented Oct 19, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

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

Uh oh!

Conversation

himself65 commented Oct 16, 2023

Uh oh!

Mifrill Oct 17, 2023

Choose a reason for hiding this comment

Uh oh!

himself65 Oct 17, 2023

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 17, 2023

Uh oh!

nodejs-github-bot commented Oct 18, 2023

Uh oh!

nodejs-github-bot commented Oct 18, 2023

Uh oh!

nodejs-github-bot commented Oct 18, 2023

Uh oh!

nodejs-github-bot commented Oct 19, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants