doc: clarify async iterator leak

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 <jasnell@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
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 <jasnell@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
nodejs · ronag · ronag · ronag · Aug 6, 2019 · nodejs-github-bot
diff --git a/doc/api/stream.md b/doc/api/stream.md
@@ -2499,6 +2499,14 @@ and async iterators are provided below.
 })();
 ```

+Async iterators register a permanent error handler. If the iterator is not
+fully consumed, any unhandled stream error will be swallowed. When consuming
+streams using async iterators any errors emitted after `'end'` or `'close'`
-streams using async iterators any errors emitted after `'end'` or `'close'`
+streams using async iterators, any errors emitted after `'end'` or `'close'`
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.
-unhandled post-destroy errors.
+unhandled errors after `destroy()` executes.