Skip to content

Commit d5efecd

Browse files
Trottdanielleadams
authored andcommitted
doc: simplify readline/stdin text
PR-URL: #41583 Reviewed-By: Mestery <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
1 parent 9601b8d commit d5efecd

File tree

1 file changed

+3
-10
lines changed

1 file changed

+3
-10
lines changed

doc/api/readline.md

+3-10
Original file line numberDiff line numberDiff line change
@@ -658,15 +658,8 @@ a `'resize'` event on the `output` if or when the columns ever change
658658
([`process.stdout`][] does this automatically when it is a TTY).
659659

660660
When creating a `readline.Interface` using `stdin` as input, the program
661-
will not terminate until it receives `EOF` (<kbd>Ctrl</kbd>+<kbd>D</kbd> on
662-
Linux/macOS, <kbd>Ctrl</kbd>+<kbd>Z</kbd> followed by <kbd>Return</kbd> on
663-
Windows).
664-
If you want your application to exit without waiting for user input, you can
665-
[`unref()`][] the standard input stream:
666-
667-
```js
668-
process.stdin.unref();
669-
```
661+
will not terminate until it receives an [EOF character][]. To exit without
662+
waiting for user input, call `process.stdin.unref()`.
670663

671664
### Use of the `completer` function
672665

@@ -994,6 +987,7 @@ const { createInterface } = require('readline');
994987
</tr>
995988
</table>
996989

990+
[EOF character]: https://en.wikipedia.org/wiki/End-of-file#EOF_character
997991
[Readable]: stream.md#readable-streams
998992
[TTY]: tty.md
999993
[TTY keybindings]: #tty-keybindings
@@ -1005,5 +999,4 @@ const { createInterface } = require('readline');
1005999
[`process.stdin`]: process.md#processstdin
10061000
[`process.stdout`]: process.md#processstdout
10071001
[`rl.close()`]: #rlclose
1008-
[`unref()`]: net.md#socketunref
10091002
[reading files]: #example-read-file-stream-line-by-line

0 commit comments

Comments
 (0)