Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: readline.emitKeypressEvents and raw mode #6628

Closed
wants to merge 1 commit into from
Closed

doc: readline.emitKeypressEvents and raw mode #6628

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions doc/api/readline.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,15 @@ Move cursor to the specified position in a given TTY stream.
Causes `stream` to begin emitting `'keypress'` events corresponding to its
input.

Note that the stream, if it is a TTY, needs to be in raw mode:
```js
readline.emitKeypressEvents(process.stdin);
if (process.stdin.isTTY) {
// might not be a TTY if spawned from another node process
process.stdin.setRawMode(true);
}
```

## readline.moveCursor(stream, dx, dy)

Move cursor relative to it's current position in a given TTY stream.
Expand Down