Skip to content

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

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.

Sign up for GitHub

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

Closed
rexagod wants to merge 7 commits into from
Closed

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

Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
35f4e6c
docs: end(cb) cb can be invoked with error
rexagod Mar 12, 2020
3e0395a
Update stream.md
rexagod Mar 12, 2020
89d4a32
remove additional details and add YAML metadata
rexagod Mar 16, 2020
0f7e2f5
Merge branch 'master' of github.com:nodejs/node into writable-end-docs
rexagod Mar 16, 2020
a0472d2
remove additional details and add YAML metadata
rexagod Mar 16, 2020
f570912
Update stream.md
rexagod Mar 29, 2020
78a6211
Update doc/api/stream.md
rexagod Mar 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,9 @@ Is `true` after [`writable.destroy()`][writable-destroy] has been called.
<!-- YAML
added: v0.9.4
changes:
- version: v13.11.0
pr-url: https://github.com/nodejs/node/pull/32238
description: The `callback` is invoked if 'finish' or 'error' is emitted.
- version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18780
description: This method now returns a reference to `writable`.
Expand All @@ -418,14 +421,15 @@ changes:
`Uint8Array`. For object mode streams, `chunk` may be any JavaScript value
other than `null`.
* `encoding` {string} The encoding if `chunk` is a string
* `callback` {Function} Optional callback for when the stream is finished
* `callback` {Function} Optional callback for when the stream finishes
or errors
* Returns: {this}

Calling the `writable.end()` method signals that no more data will be written
to the [`Writable`][]. The optional `chunk` and `encoding` arguments allow one
final additional chunk of data to be written immediately before closing the
stream. If provided, the optional `callback` function is attached as a listener
for the [`'finish'`][] event.
for the [`'finish'`][] and the `'error'` event.

Calling the [`stream.write()`][stream-write] method after calling
[`stream.end()`][stream-end] will raise an error.
Expand Down