doc: clarify pipeline stream cleanup

ronag · targos · commit 2ea4cc073291 · 2019-10-01T14:37:22.000+02:00
PR-URL: #29738 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
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.
