doc: readline.emitKeypressEvents and raw mode

`readline.emitKeypressEvents` needs `stream` to be in raw mode. PR-URL: #6628 Fixes: #6626 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Roman Klauke <[email protected]>
nodejs · May 17, 2016 · 2273971 · 2273971
1 parent 1c7b6e2
commit 2273971
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/doc/api/readline.md b/doc/api/readline.md
@@ -362,6 +362,15 @@ Move cursor to the specified position in a given TTY stream.
 Causes `stream` to begin emitting `'keypress'` events corresponding to its
 input.
 
+Note that the stream, if it is a TTY, needs to be in raw mode:
+```js
+readline.emitKeypressEvents(process.stdin);
+if (process.stdin.isTTY) {
+  // might not be a TTY if spawned from another node process
+  process.stdin.setRawMode(true);
+}
+```
+
 ## readline.moveCursor(stream, dx, dy)
 
 Move cursor relative to it's current position in a given TTY stream.