Commit 2273971
doc: readline.emitKeypressEvents and raw mode
`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>1 parent 1c7b6e2 commit 2273971
1 file changed
Lines changed: 9 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -362,6 +362,15 @@ Move cursor to the specified position in a given TTY stream. | |||
| 362 | 362 | Causes `stream` to begin emitting `'keypress'` events corresponding to its | |
| 363 | 363 | input. | |
| 364 | 364 | ||
| 365 | + Note that the stream, if it is a TTY, needs to be in raw mode: | ||
| 366 | + ```js | ||
| 367 | + readline.emitKeypressEvents(process.stdin); | ||
| 368 | + if (process.stdin.isTTY) { | ||
| 369 | + // might not be a TTY if spawned from another node process | ||
| 370 | + process.stdin.setRawMode(true); | ||
| 371 | + } | ||
| 372 | + ``` | ||
| 373 | + | ||
| 365 | 374 | ## readline.moveCursor(stream, dx, dy) | |
| 366 | 375 | ||
| 367 | 376 | Move cursor relative to it's current position in a given TTY stream. | |
0 commit comments