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: end(cb) cb can be invoked with error #31220

Closed
ronag opened this issue Jan 6, 2020 · 1 comment
Closed

docs: end(cb) cb can be invoked with error #31220

ronag opened this issue Jan 6, 2020 · 1 comment
Labels
good first issue Issues that are suitable for first-time contributors. stream Issues and PRs related to the stream subsystem.

Comments

@ronag
Copy link
Member

ronag commented Jan 6, 2020

callback Optional callback for when the stream is finished

https://nodejs.org/dist/latest-v13.x/docs/api/stream.html#stream_writable_end_chunk_encoding_callback

Should be updated to indicate that the callback can also be invoked with error.

@ronag
Copy link
Member Author

ronag commented Jan 6, 2020

Waiting for consensus on the callback discussion #31179 (comment)

@ronag ronag changed the title docs: end(cb) cb will be invoked with error as well. docs: end(cb) cb can be invoked with error Jan 6, 2020
@ronag ronag added good first issue Issues that are suitable for first-time contributors. stream Issues and PRs related to the stream subsystem. labels Mar 10, 2020
rexagod added a commit to rexagod/node that referenced this issue Mar 12, 2020
update docs that the optional callback passed to
`writable.end` can be invoked in case of an error as well

fixes: nodejs#31220
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Issues that are suitable for first-time contributors. stream Issues and PRs related to the stream subsystem.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant