Browse Source

doc: add readline.emitKeypressEvents note

PR-URL: https://github.com/nodejs/node/pull/9447
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
v6
Samuel Reed 8 years ago
committed by Anna Henningsen
parent
commit
ac3477971f
No known key found for this signature in database GPG Key ID: D8B9F5AEAE84E4CF
  1. 4
      doc/api/readline.md

4
doc/api/readline.md

@ -457,6 +457,10 @@ autocompletion is disabled when copy-pasted input is detected.
If the `stream` is a [TTY][], then it must be in raw mode.
*Note*: This is automatically called by any readline instance on its `input`
if the `input` is a terminal. Closing the `readline` instance does not stop
the `input` from emitting `'keypress'` events.
```js
readline.emitKeypressEvents(process.stdin);
if (process.stdin.isTTY)

Loading…
Cancel
Save