From b2624f5c58478f7753b1a8d05d6c30cf8a85b5c1 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 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit PR-URL: https://github.com/nodejs/node/pull/15316 Fixes: https://github.com/nodejs/node/issues/15291 Reviewed-By: Colin Ihrig Reviewed-By: Matteo Collina Reviewed-By: Luigi Pinca Reviewed-By: Daniel Bevenius Reviewed-By: Tobias Nießen Reviewed-By: James M Snell Reviewed-By: Ruben Bridgewater --- doc/api/stream.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/api/stream.md b/doc/api/stream.md index f8248aae40..8aaa4ff2e6 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])