-
Notifications
You must be signed in to change notification settings - Fork 29.6k
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
doc: add pipeline and finished to stream/promises doc #45832
doc: add pipeline and finished to stream/promises doc #45832
Conversation
e5f6cfc
to
f67e107
Compare
acb6aa0
to
0eee704
Compare
0eee704
to
9175ce3
Compare
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.
Thanks for doing this! Can you add back link to the callback methods and add link this this methods from the callback docs? Adding code examples would be great also.
I've moved the async examples under the new async documentation and created links |
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.
Looks good. Let's use top-level await on ESM when possible.
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
Commit Queue failed- Loading data for nodejs/node/pull/45832 ✔ Done loading data for nodejs/node/pull/45832 ----------------------------------- PR info ------------------------------------ Title doc: add pipeline and finished to stream/promises doc (#45832) Author Marco Ippolito (@marco-ippolito) Branch marco-ippolito:doc/stream-promises -> nodejs:main Labels author ready, needs-ci, dependencies, commit-queue-squash Commits 6 - doc: add stream/promises pipeline and finished to doc - doc: fixed correct return type - doc: improved documentation - doc: typo removed > - doc: top level await and typo - doc: fix setImmediate Committers 2 - Marco Ippolito - GitHub PR-URL: https://github.com/nodejs/node/pull/45832 Fixes: https://github.com/nodejs/node/issues/45821 Reviewed-By: Paolo Insogna Reviewed-By: Antoine du Hamel ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/45832 Fixes: https://github.com/nodejs/node/issues/45821 Reviewed-By: Paolo Insogna Reviewed-By: Antoine du Hamel -------------------------------------------------------------------------------- ⚠ Commits were pushed since the last review: ⚠ - doc: fix setImmediate ℹ This PR was created on Mon, 12 Dec 2022 18:51:35 GMT ✔ Approvals: 2 ✔ - Paolo Insogna (@ShogunPanda): https://github.com/nodejs/node/pull/45832#pullrequestreview-1217021378 ✔ - Antoine du Hamel (@aduh95) (TSC): https://github.com/nodejs/node/pull/45832#pullrequestreview-1218851209 ✔ Last GitHub CI successful ✖ No Jenkins CI runs detected -------------------------------------------------------------------------------- ✔ Aborted `git node land` session in /home/runner/work/node/node/.ncuhttps://github.com/nodejs/node/actions/runs/3703786198 |
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
Not sure why GitHub didn't run CI on the lastest commit, closing and reopening to trigger CI. |
Commit Queue failed- Loading data for nodejs/node/pull/45832 ✔ Done loading data for nodejs/node/pull/45832 ----------------------------------- PR info ------------------------------------ Title doc: add pipeline and finished to stream/promises doc (#45832) Author Marco Ippolito (@marco-ippolito) Branch marco-ippolito:doc/stream-promises -> nodejs:main Labels author ready, needs-ci, dependencies, commit-queue-squash Commits 8 - doc: add stream/promises pipeline and finished to doc - doc: fixed correct return type - doc: improved documentation - doc: typo removed > - doc: top level await and typo - doc: fix setImmediate - fix: period instead of : - doc: newline Committers 2 - Marco Ippolito - GitHub PR-URL: https://github.com/nodejs/node/pull/45832 Fixes: https://github.com/nodejs/node/issues/45821 Reviewed-By: Paolo Insogna Reviewed-By: Antoine du Hamel ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/45832 Fixes: https://github.com/nodejs/node/issues/45821 Reviewed-By: Paolo Insogna Reviewed-By: Antoine du Hamel -------------------------------------------------------------------------------- ℹ This PR was created on Mon, 12 Dec 2022 18:51:35 GMT ✔ Approvals: 2 ✔ - Paolo Insogna (@ShogunPanda): https://github.com/nodejs/node/pull/45832#pullrequestreview-1217021378 ✔ - Antoine du Hamel (@aduh95) (TSC): https://github.com/nodejs/node/pull/45832#pullrequestreview-1219295708 ✔ Last GitHub CI successful ✖ No Jenkins CI runs detected -------------------------------------------------------------------------------- ✔ Aborted `git node land` session in /home/runner/work/node/node/.ncuhttps://github.com/nodejs/node/actions/runs/3705387087 |
Landed in 4166d40 |
I've added to the doc the signature of
pipeline
andfinished
which was missing.@ronag I've also added the
end
field which was mentioned here #34805 (comment) but I'm not sure if that's all right.Fixes: #45821