Skip to content

Commit

Permalink
doc: add missing doc for readable._destroy
Browse files Browse the repository at this point in the history
PR-URL: #15316
Fixes: #15291
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
  • Loading branch information
targos authored and jasnell committed Sep 20, 2017
1 parent a2c335b commit 29707af
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions doc/api/stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -1601,6 +1601,15 @@ The `readable._read()` method is prefixed with an underscore because it is
internal to the class that defines it, and should never be called directly by
user programs.

#### readable.\_destroy(err, callback)
<!-- YAML
added: v8.0.0
-->

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

#### readable.push(chunk[, encoding])
<!-- YAML
changes:
Expand Down

0 comments on commit 29707af

Please sign in to comment.