From 46e15e56ad1221a2e32357d07137809a0f7c7523 Mon Sep 17 00:00:00 2001 From: Anu Pasumarthy Date: Thu, 1 Apr 2021 17:07:50 -0400 Subject: [PATCH] address comments: typo, windows eof terminate --- doc/api/readline.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/api/readline.md b/doc/api/readline.md index f9eda125afc060..4bfa3659134e6e 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -628,8 +628,10 @@ the best compatibility if it defines an `output.columns` property and emits a `'resize'` event on the `output` if or when the columns ever change ([`process.stdout`][] does this automatically when it is a TTY). -When creating a `readline.Interface` using `stdin` as input stream, the program -will notterminate until it receives `EOF` (Ctrl+D). +When creating a `readline.Interface` using `stdin` as input, the program +will not terminate until it receives `EOF` (Ctrl+D on +Linux/MacOS, Ctrl+Z followed by return on +Windows). If you want your application to exit without waiting for user input, you can `unref` the standard input: