1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: clarify async iterator leak

Browse Source 
Clarifies that creating multiple async iterators from the same stream
can lead to event listener leak.

PR-URL: https://github.com/nodejs/node/pull/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>
This commit is contained in:
Robert Nagy 2019-08-06 11:34:51 +02:00 committed by Rich Trott
parent f985a25ba7
commit d7a4ace34b
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/api/stream.md
View File

@ -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 #### Creating Readable Streams with Async Generators
We can construct a Node.js Readable Stream from an asynchronous generator We can construct a Node.js Readable Stream from an asynchronous generator