doc: readline.emitKeypressEvents and raw mode #6628
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
addaleax
added
the
readline
arve0
changed the title
| @@ -362,6 +362,12 @@ 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 need to be in raw mode: | |||
|
@nodejs/documentation |
|
Might wanna add a check that the stream is a TTY in the example? if (process.stdin.isTTY) {
// might not be a TTY if spawned from another node process
process.stdin.setRawMode(true)
} |
| @@ -362,6 +362,12 @@ 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 needs to be in raw mode: | |||
There was a problem hiding this comment.
“… the stream, if it is a TTY, needs to be…”?
|
@arve0 +1 to adding that check to the example. LGTM apart from that. |
`readline.emitKeypressEvents` needs `stream` to be in raw mode, ref nodejs#6626
|
Updated. |
|
LGTM |
|
Landed in 1ba5a56. Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
Affected core subsystem(s)
doc
Description of change
readline.emitKeypressEventsneedsstreamto be in raw mode, fixes #6626