Skip to content

Commit

Permalink
doc: add documentation for stream.destroyed
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
ronag authored and targos committed Aug 2, 2019
1 parent 5d5c89a commit ffc7a00
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions doc/api/stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -380,6 +380,15 @@ the `'drain'` event before destroying the stream.
Implementors should not override this method,
but instead implement [`writable._destroy()`][writable-_destroy].

##### writable.destroyed
<!-- YAML
added: v8.0.0
-->

* {boolean}

Is `true` after [`writable.destroy()`][writable-destroy] has been called.

##### writable.end([chunk][, encoding][, callback])
<!-- YAML
added: v0.9.4
Expand Down Expand Up @@ -916,6 +925,15 @@ will be ignored.
Implementors should not override this method, but instead implement
[`readable._destroy()`][readable-_destroy].

##### readable.destroyed
<!-- YAML
added: v8.0.0
-->

* {boolean}

Is `true` after [`readable.destroy()`][readable-destroy] has been called.

##### readable.isPaused()
<!-- YAML
added: v0.11.14
Expand Down

0 comments on commit ffc7a00

Please sign in to comment.