doc: clarify async iterator leak

Clarifies that creating multiple async iterators from the same stream can lead to event listener leak. PR-URL: nodejs#28997 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
Trott · Aug 12, 2019 · d7a4ace · d7a4ace
1 parent f985a25
commit d7a4ace
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