Skip to content

Commit

Permalink
doc: document how to unref stdin when using readline.Interface
Browse files Browse the repository at this point in the history
PR-URL: #38019
Fixes: #36154
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
  • Loading branch information
AnupamaP authored and targos committed May 1, 2021
1 parent d6346e1 commit df54edc
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions doc/api/readline.md
Original file line number Diff line number Diff line change
Expand Up @@ -556,6 +556,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
Expand Down Expand Up @@ -891,3 +902,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

0 comments on commit df54edc

Please sign in to comment.