doc: add readline.emitKeypressEvents note

PR-URL: #9447 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
nodejs · Jun 12, 2017 · 2c1133d · 2c1133d
1 parent a5f415f
commit 2c1133d
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/doc/api/readline.md b/doc/api/readline.md
@@ -457,6 +457,10 @@ autocompletion is disabled when copy-pasted input is detected.
 
 If the `stream` is a [TTY][], then it must be in raw mode.
 
+*Note*: This is automatically called by any readline instance on its `input`
+if the `input` is a terminal. Closing the `readline` instance does not stop
+the `input` from emitting `'keypress'` events.
+
 ```js
 readline.emitKeypressEvents(process.stdin);
 if (process.stdin.isTTY)