doc: update write callback documentation #38959
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- replace _*may or may not* be called_ with _will be called_ because the callback is always called - remove _To reliably detect write errors, add a listener for the `'error'` event_ because the `error` event will NOT be emitted if a write occurs after the stream has been closed
github-actions
bot
added
doc
jasnell
approved these changes
Jun 7, 2021
aduh95
approved these changes
Jun 7, 2021
aduh95
added
dont-land-on-v12.x
author ready
|
If I understand the linked issue correctly, this is true only for Node.js v15+. Adding the labels so it doesn't get backported, feel free to remove them if I misunderstood the situation. |
|
@nodejs/streams |
benjamingr
approved these changes
Jun 7, 2021
ronag
approved these changes
Jun 7, 2021
mmarchini
added
the
commit-queue
github-actions
bot
removed
the
commit-queue
Commit Queue failed- Loading data for nodejs/node/pull/38959 ✔ Done loading data for nodejs/node/pull/38959 ----------------------------------- PR info ------------------------------------ Title doc: update write callback documentation (#38959) ⚠ Could not retrieve the email or name of the PR author's from user's GitHub profile! Branch simoneb:patch-1 -> nodejs:master Labels author ready, doc, dont-land-on-v12.x, dont-land-on-v14.x, stream Commits 1 - doc: update write callback documentation Committers 1 - GitHub PR-URL: https://github.com/nodejs/node/pull/38959 Fixes: https://github.com/nodejs/node/issues/38704 Reviewed-By: James M Snell Reviewed-By: Antoine du Hamel Reviewed-By: Benjamin Gruenbaum Reviewed-By: Robert Nagy Reviewed-By: Matteo Collina ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/38959 Fixes: https://github.com/nodejs/node/issues/38704 Reviewed-By: James M Snell Reviewed-By: Antoine du Hamel Reviewed-By: Benjamin Gruenbaum Reviewed-By: Robert Nagy Reviewed-By: Matteo Collina -------------------------------------------------------------------------------- ℹ This PR was created on Mon, 07 Jun 2021 14:02:22 GMT ✔ Approvals: 5 ✔ - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/38959#pullrequestreview-677503321 ✔ - Antoine du Hamel (@aduh95) (TSC): https://github.com/nodejs/node/pull/38959#pullrequestreview-677663819 ✔ - Benjamin Gruenbaum (@benjamingr): https://github.com/nodejs/node/pull/38959#pullrequestreview-677841411 ✔ - Robert Nagy (@ronag) (TSC): https://github.com/nodejs/node/pull/38959#pullrequestreview-677850823 ✔ - Matteo Collina (@mcollina) (TSC): https://github.com/nodejs/node/pull/38959#pullrequestreview-678297907 ✖ Last GitHub CI failed ℹ Green GitHub Actions CI is sufficient -------------------------------------------------------------------------------- ✔ Aborted `git node land` session in /home/runner/work/node/node/.ncuhttps://github.com/nodejs/node/actions/runs/926267471 |
github-actions
bot
added
the
commit-queue-failed
mmarchini
added
commit-queue
github-actions
bot
added
commit-queue-failed
Commit Queue failed- Loading data for nodejs/node/pull/38959 ✔ Done loading data for nodejs/node/pull/38959 ----------------------------------- PR info ------------------------------------ Title doc: update write callback documentation (#38959) ⚠ Could not retrieve the email or name of the PR author's from user's GitHub profile! Branch simoneb:patch-1 -> nodejs:master Labels author ready, doc, dont-land-on-v12.x, dont-land-on-v14.x, stream Commits 1 - doc: update write callback documentation Committers 1 - GitHub PR-URL: https://github.com/nodejs/node/pull/38959 Fixes: https://github.com/nodejs/node/issues/38704 Reviewed-By: James M Snell Reviewed-By: Antoine du Hamel Reviewed-By: Benjamin Gruenbaum Reviewed-By: Robert Nagy Reviewed-By: Matteo Collina ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/38959 Fixes: https://github.com/nodejs/node/issues/38704 Reviewed-By: James M Snell Reviewed-By: Antoine du Hamel Reviewed-By: Benjamin Gruenbaum Reviewed-By: Robert Nagy Reviewed-By: Matteo Collina -------------------------------------------------------------------------------- ℹ This PR was created on Mon, 07 Jun 2021 14:02:22 GMT ✔ Approvals: 5 ✔ - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/38959#pullrequestreview-677503321 ✔ - Antoine du Hamel (@aduh95) (TSC): https://github.com/nodejs/node/pull/38959#pullrequestreview-677663819 ✔ - Benjamin Gruenbaum (@benjamingr): https://github.com/nodejs/node/pull/38959#pullrequestreview-677841411 ✔ - Robert Nagy (@ronag) (TSC): https://github.com/nodejs/node/pull/38959#pullrequestreview-677850823 ✔ - Matteo Collina (@mcollina) (TSC): https://github.com/nodejs/node/pull/38959#pullrequestreview-678297907 ✔ Last GitHub Actions successful ℹ Green GitHub Actions CI is sufficient -------------------------------------------------------------------------------- ✔ No git cherry-pick in progress ✔ No git am in progress ✔ No git rebase in progress -------------------------------------------------------------------------------- - Bringing origin/master up to date... From https://github.com/nodejs/node * branch master -> FETCH_HEAD ✔ origin/master is now up-to-date - Downloading patch for 38959 From https://github.com/nodejs/node * branch refs/pull/38959/merge -> FETCH_HEAD ✔ Fetched commits as 52f8471b5281..453d7dbcbd99 -------------------------------------------------------------------------------- [master d77e235f62] doc: update write callback documentation Author: Simone Busoli Date: Mon Jun 7 16:01:49 2021 +0200 1 file changed, 2 insertions(+), 3 deletions(-) ✔ Patches applied -------------------------------------------------------------------------------- --------------------------------- New Message ---------------------------------- doc: update write callback documentation
PR-URL: #38959
|
mmarchini
pushed a commit
that referenced
this pull request
Jun 10, 2021
- replace _*may or may not* be called_ with _will be called_ because the callback is always called - remove _To reliably detect write errors, add a listener for the `'error'` event_ because the `error` event will NOT be emitted if a write occurs after the stream has been closed PR-URL: #38959 Fixes: #38704 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Robert Nagy <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
|
Landed in cf609cc |
targos
pushed a commit
that referenced
this pull request
Jun 11, 2021
- replace _*may or may not* be called_ with _will be called_ because the callback is always called - remove _To reliably detect write errors, add a listener for the `'error'` event_ because the `error` event will NOT be emitted if a write occurs after the stream has been closed PR-URL: #38959 Fixes: #38704 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Robert Nagy <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
Merged
danielleadams
pushed a commit
that referenced
this pull request
Jun 17, 2021
- replace _*may or may not* be called_ with _will be called_ because the callback is always called - remove _To reliably detect write errors, add a listener for the `'error'` event_ because the `error` event will NOT be emitted if a write occurs after the stream has been closed PR-URL: #38959 Fixes: #38704 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Robert Nagy <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
targos
removed
the
commit-queue-failed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
'error'event because theerrorevent will NOT be emitted if a write occurs after the stream has been closedFixes: #38704