doc: readline.emitKeypressEvents and raw mode

arve0 · evanlucas · commit 2273971a696c · 2016-05-17T08:39:25.000-05:00
`readline.emitKeypressEvents` needs `stream` to be in raw mode. PR-URL: #6628 Fixes: #6626 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Roman Klauke <romaaan.git@gmail.com>
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.
