1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: readline.emitKeypressEvents and raw mode

Browse Source 
`readline.emitKeypressEvents` needs `stream` to be in raw mode.

PR-URL: https://github.com/nodejs/node/pull/6628
Fixes: https://github.com/nodejs/node/issues/6626
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Roman Klauke <romaaan.git@gmail.com>
This commit is contained in:
Arve Seljebu 2016-05-07 09:53:05 +02:00 committed by Anna Henningsen
parent 9c33e0ebe7
commit 1ba5a56f49
No known key found for this signature in database
GPG Key ID: D8B9F5AEAE84E4CF
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/api/readline.md
View File

@ -364,6 +364,15 @@ input.
Optionally, `interface` specifies a `readline.Interface` instance for which
autocompletion is disabled when copy-pasted input is detected.
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.