Skip to content

Commit

Permalink
doc: improve {readable,writable}._destroy() docs
Browse files Browse the repository at this point in the history
PR-URL: nodejs#16313
Reviewed-By: Anatoli Papirovski <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
Reviewed-By: Gireesh Punathil <[email protected]>
  • Loading branch information
lpinca authored and gireeshpunathil committed Oct 21, 2017
1 parent f8063d5 commit 1395106
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions doc/api/stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -1437,9 +1437,12 @@ user programs.
added: v8.0.0
-->

* `err` {Error} An error.
* `callback` {Function} A callback function that takes an optional error argument
which is invoked when the writable is destroyed.
* `err` {Error} A possible error.
* `callback` {Function} A callback function that takes an optional error
argument.

The `_destroy()` method is called by [`writable.destroy()`][writable-destroy].
It can be overriden by child classes but it **must not** be called directly.

#### writable.\_final(callback)
<!-- YAML
Expand Down Expand Up @@ -1606,9 +1609,12 @@ user programs.
added: v8.0.0
-->

* `err` {Error} An error.
* `err` {Error} A possible error.
* `callback` {Function} A callback function that takes an optional error
argument which is invoked when the readable is destroyed.
argument.

The `_destroy()` method is called by [`readable.destroy()`][readable-destroy].
It can be overriden by child classes but it **must not** be called directly.

#### readable.push(chunk[, encoding])
<!-- YAML
Expand Down Expand Up @@ -2232,4 +2238,6 @@ contain multi-byte characters.
[stream-resume]: #stream_readable_resume
[stream-write]: #stream_writable_write_chunk_encoding_callback
[readable-_destroy]: #stream_readable_destroy_err_callback
[readable-destroy]: #stream_readable_destroy_error
[writable-_destroy]: #stream_writable_destroy_err_callback
[writable-destroy]: #stream_writable_destroy_error

0 comments on commit 1395106

Please sign in to comment.