Browse Source

doc: add missing doc for readable._destroy

PR-URL: https://github.com/nodejs/node/pull/15316
Fixes: https://github.com/nodejs/node/issues/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>
canary-base
Michaël Zasso 8 years ago
committed by Ruben Bridgewater
parent
commit
99a779947c
No known key found for this signature in database GPG Key ID: F07496B3EB3C1762
  1. 9
      doc/api/stream.md

9
doc/api/stream.md

@ -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:

Loading…
Cancel
Save