doc: clarify pipeline stream cleanup

PR-URL: #29738 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Rich Trott <[email protected]>
nodejs · Oct 1, 2019 · 2ea4cc0 · 2ea4cc0
1 parent ab060bf
commit 2ea4cc0
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/doc/api/stream.md b/doc/api/stream.md
@@ -1587,6 +1587,10 @@ async function run() {
 run().catch(console.error);
 ```
 
+`stream.pipeline()` will call `stream.destroy(err)` on all streams except:
+* `Readable` streams which have emitted `'end'` or `'close'`.
+* `Writable` streams which have emitted `'finish'` or `'close'`.
+
 `stream.pipeline()` leaves dangling event listeners on the streams
 after the `callback` has been invoked. In the case of reuse of streams after
 failure, this can cause event listener leaks and swallowed errors.