From 6d9d899650100ddb05fc622da45e5f70229641db Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Zasso?= Date: Sun, 10 Sep 2017 15:53:57 +0200 Subject: [PATCH] doc: add missing doc for readable._destroy Fixes: https://github.com/nodejs/node/issues/15291 --- doc/api/stream.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/api/stream.md b/doc/api/stream.md index efa69532ef81f8..e285db76055805 100644 --- a/doc/api/stream.md +++ b/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) + + +* `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])