From ac3477971fda14db00dedec6ac752b6da8a07bf8 Mon Sep 17 00:00:00 2001 From: Samuel Reed Date: Thu, 3 Nov 2016 11:23:57 -0500 Subject: [PATCH] doc: add readline.emitKeypressEvents note PR-URL: https://github.com/nodejs/node/pull/9447 Reviewed-By: Anna Henningsen Reviewed-By: Gibson Fahnestock --- doc/api/readline.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/api/readline.md b/doc/api/readline.md index bcd68d8085..767f8ccefc 100644 --- a/doc/api/readline.md +++ b/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)