doc: add unref for input in readline

nodejs · Apr 1, 2021 · a5fe4a9 · a5fe4a9
1 parent 31fe3b2
commit a5fe4a9
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/doc/api/readline.md b/doc/api/readline.md
@@ -628,6 +628,13 @@ 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).
 
+In order to end the wait for the `stdin` input stream (so that the program
+does not appear to have hanged), `unref` function can be used:
+
+```js
+process.stdin.unref();
+```
+
 ### Use of the `completer` function
 
 The `completer` function takes the current line entered by the user