Skip to content

doc: document stream.isDestroyed() #64789

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

Open
YspritanHyzygy wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −0
Open

doc: document stream.isDestroyed() #64789

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
13 changes: 13 additions & 0 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3120,6 +3120,19 @@ console.log(res); // prints 'HELLOWORLD'
For convenience, the [`readable.compose(stream)`][] method is available on
{Readable} and {Duplex} streams as a wrapper for this function.

### `stream.isDestroyed(stream)`

<!-- YAML
added:
- v19.9.0
- v18.17.0
-->

* `stream` {Readable|Writable|Duplex}
* Returns: {boolean|null} - Only returns `null` if `stream` is not a valid `Readable`, `Writable` or `Duplex`.

Returns whether the stream has been destroyed.

### `stream.isErrored(stream)`

<!-- YAML
Expand Down
Loading