From 1ba5a56f492b184b71964bd5dd42cc4266d6627e Mon Sep 17 00:00:00 2001 From: Arve Seljebu Date: Sat, 7 May 2016 09:53:05 +0200 Subject: 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 Reviewed-By: Roman Klauke --- doc/api/readline.md | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'doc/api/readline.md') diff --git a/doc/api/readline.md b/doc/api/readline.md index a9478ac0b8..cc71b20bc9 100644 --- a/doc/api/readline.md +++ b/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. -- cgit v1.2.1