Skip to content

Commit ffc7a00

Browse files
ronagtargos
authored andcommitted
doc: add documentation for stream.destroyed
PR-URL: #28815 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
1 parent 5d5c89a commit ffc7a00

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

doc/api/stream.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -380,6 +380,15 @@ the `'drain'` event before destroying the stream.
380380
Implementors should not override this method,
381381
but instead implement [`writable._destroy()`][writable-_destroy].
382382

383+
##### writable.destroyed
384+
<!-- YAML
385+
added: v8.0.0
386+
-->
387+
388+
* {boolean}
389+
390+
Is `true` after [`writable.destroy()`][writable-destroy] has been called.
391+
383392
##### writable.end([chunk][, encoding][, callback])
384393
<!-- YAML
385394
added: v0.9.4
@@ -916,6 +925,15 @@ will be ignored.
916925
Implementors should not override this method, but instead implement
917926
[`readable._destroy()`][readable-_destroy].
918927

928+
##### readable.destroyed
929+
<!-- YAML
930+
added: v8.0.0
931+
-->
932+
933+
* {boolean}
934+
935+
Is `true` after [`readable.destroy()`][readable-destroy] has been called.
936+
919937
##### readable.isPaused()
920938
<!-- YAML
921939
added: v0.11.14

0 commit comments

Comments
 (0)