From ced82e457cba2a38d906f38a5b3622c72bc4fce0 Mon Sep 17 00:00:00 2001 From: Anu Pasumarthy Date: Fri, 2 Apr 2021 09:09:51 -0400 Subject: [PATCH] address comments --- doc/api/readline.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/api/readline.md b/doc/api/readline.md index 09ff2e62ea0c5f..b2c0ddc8c3d447 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -628,12 +628,12 @@ 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 +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 stream: +[`unref`][] the standard input stream: ```js process.stdin.unref(); @@ -974,3 +974,4 @@ const { createInterface } = require('readline'); [`process.stdout`]: process.md#process_process_stdout [`rl.close()`]: #readline_rl_close [reading files]: #readline_example_read_file_stream_line_by_line +[`unref`]: net.md#net_socket_unref