Browse Source

doc: readline.emitKeypressEvents and raw mode

`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>
v7.x
Arve Seljebu 9 years ago
committed by Anna Henningsen
parent
commit
1ba5a56f49
No known key found for this signature in database GPG Key ID: D8B9F5AEAE84E4CF
  1. 9
      doc/api/readline.md

9
doc/api/readline.md

@ -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.

Loading…
Cancel
Save