OSSForks/node
1
0
Fork 0
mirror of https://github.com/zebrajr/node.git synced 2025-12-06 12:20:27 +01:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

doc: document how to unref stdin when using readline.Interface

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/38019
Fixes: https://github.com/nodejs/node/issues/36154
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
This commit is contained in:
Anu Pasumarthy 2021-04-01 09:09:11 -04:00 committed by Myles Borins
parent b02c352ad6
commit b40d35d649
No known key found for this signature in database
GPG Key ID: 933B01F40B5CA946
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/api/readline.md
View File

@ -633,6 +633,17 @@ 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, the program
will not terminate until it receives `EOF` (<kbd>Ctrl</kbd>+<kbd>D</kbd> on
Linux/macOS, <kbd>Ctrl</kbd>+<kbd>Z</kbd> followed by <kbd>Return</kbd> on
Windows).
If you want your application to exit without waiting for user input, you can
[`unref`][] the standard input stream:
```js
process.stdin.unref();
```
### Use of the `completer` function
The `completer` function takes the current line entered by the user
@ -968,3 +979,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