doc: add a note about possible missing lines to readline.asyncIterator

Fixes: #33463 PR-URL: #34675 Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Anto Aravinth <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: Rich Trott <[email protected]>
nodejs · Apr 3, 2022 · 333eda8 · 333eda8
1 parent 518a49c
commit 333eda8
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/doc/api/readline.md b/doc/api/readline.md
@@ -352,6 +352,10 @@ async function processLineByLine() {
 }
 ```
 
+`readline.createInterface()` will start to consume the input stream once
+invoked. Having asynchronous operations between interface creation and
+asynchronous iteration may result in missed lines.
+
 ### rl.line
 <!-- YAML
 added: v0.1.98