Skip to content

doc: add missing doc for readable._destroy #15316

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
targos wants to merge 1 commit into from
Closed

doc: add missing doc for readable._destroy #15316

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
doc: add missing doc for readable._destroy 
Fixes: #15291
  • Loading branch information
@targos
targos committed Sep 10, 2017
commit 6d9d899650100ddb05fc622da45e5f70229641db
9 changes: 9 additions & 0 deletions doc/api/stream.md
View file
Open in desktop
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