From 5ea9237d2b3e418857fd1d4a6fa24b3262c9f985 Mon Sep 17 00:00:00 2001
From: Robert Nagy <ronagy@icloud.com>
Date: Tue, 6 Aug 2019 11:34:51 +0200
Subject: [PATCH] doc: clarify async iterator leak

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>
---
 doc/api/stream.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/doc/api/stream.md b/doc/api/stream.md
index 7d54c92f21003e..d52b635efad739 100644
--- 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