Skip to content

doc: clarify when destroy emits events #28970

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
wants to merge 1 commit into from
Closed

doc: clarify when destroy emits events #28970

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ added: v8.0.0
* Returns: {this}

Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`
event unless `emitClose` is set in `false`. After this call, the writable
event (unless `emitClose` is set to `false`). After this call, the writable
stream has ended and subsequent calls to `write()` or `end()` will result in
an `ERR_STREAM_DESTROYED` error.
This is a destructive and immediate way to destroy a stream. Previous calls to
Expand Down Expand Up @@ -919,7 +919,7 @@ added: v8.0.0
* Returns: {this}

Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`
event unless `emitClose` is set in `false`. After this call, the readable
event (unless `emitClose` is set to `false`). After this call, the readable
stream will release any internal resources and subsequent calls to `push()`
will be ignored.
Implementors should not override this method, but instead implement
Expand Down