doc: clarify async iterator leak

Clarifies that creating multiple async iterators from the same stream can lead to event listener leak. PR-URL: #28997 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
nodejs · Aug 19, 2019 · 5ea9237 · 5ea9237
1 parent 2e50088
commit 5ea9237
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/doc/api/stream.md b/doc/api/stream.md
@@ -2502,6 +2502,9 @@ and async iterators are provided below.
 })();
 ```
 
+Async iterators register a permanent error handler on the stream to prevent any
+unhandled post-destroy errors.
+
 #### Creating Readable Streams with Async Generators
 
 We can construct a Node.js Readable Stream from an asynchronous generator