summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorcjihrig <cjihrig@gmail.com>2020-04-11 15:18:43 -0400
committercjihrig <cjihrig@gmail.com>2020-04-13 20:38:12 -0400
commit581d7d4a229aa99c6fbf145b38aa5730c6dbbeef (patch)
tree99336deea88267526aeee39bfac87ea13af6f669
parentf72feb7d70057d223b1131a0527c06a025eaddd0 (diff)
downloadnode-new-581d7d4a229aa99c6fbf145b38aa5730c6dbbeef.tar.gz
doc: add transform stream destroy() return value
PR-URL: https://github.com/nodejs/node/pull/32788 Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Robert Nagy <ronagy@icloud.com> Reviewed-By: Zeyu Yang <himself65@outlook.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
-rw-r--r--doc/api/stream.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md
index 9a722ca8ad..555372a773 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -1488,6 +1488,7 @@ added: v8.0.0
-->
* `error` {Error}
+* Returns: {this}
Destroy the stream, and optionally emit an `'error'` event. After this call, the
transform stream would release any internal resources.