summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIgor Mikhalev <mr.igor.mikhalev@gmail.com>2020-08-08 10:01:36 +0300
committerRichard Lau <rlau@redhat.com>2022-04-03 13:47:11 -0400
commit333eda8d03bef36cf951bf54b33c7bbf2c0ef75c (patch)
tree33cbe193a625209fdb69e4bf93415f47f03599a8
parent518a49c0c6e0ea5300d8257da843dd78ee59a09d (diff)
downloadnode-new-333eda8d03bef36cf951bf54b33c7bbf2c0ef75c.tar.gz
doc: add a note about possible missing lines to readline.asyncIterator
Fixes: https://github.com/nodejs/node/issues/33463 PR-URL: https://github.com/nodejs/node/pull/34675 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Rich Trott <rtrott@gmail.com>
-rw-r--r--doc/api/readline.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/api/readline.md b/doc/api/readline.md
index c5829bf746..40c9f8fd08 100644
--- 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