doc: document stream.isDestroyed() · nodejs/node@72ee03b · GitHub
Skip to content

Commit 72ee03b

Browse files
YspritanHyzygyclaude
authored andcommitted
doc: document stream.isDestroyed()
`stream.isDestroyed()` has been exported since v19.9.0 but was never documented, while its siblings `isErrored()`, `isReadable()` and `isWritable()` all have entries in `doc/api/stream.md`. Unlike those, `isDestroyed()` rejects Web streams: it returns `null` for anything that is not a Node.js stream. The accepted types are therefore documented as `Readable|Writable|Duplex` rather than also listing `ReadableStream`/`WritableStream`. Refs: #45671 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Signed-off-by: YspritanHyzygy <yspritan@gmail.com> PR-URL: #64789 Reviewed-By: Aviv Keller <me@aviv.sh> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Daeyeon Jeong <daeyeon.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 1fefdda commit 72ee03b

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

doc/api/stream.md

Lines changed: 13 additions & 0 deletions

0 commit comments

Comments
 (0)