Skip to content

doc: readline.emitKeypressEvents and raw mode - #6628

Closed
arve0 wants to merge 1 commit into
nodejs:masterfrom
arve0:patch-1
Closed

doc: readline.emitKeypressEvents and raw mode#6628
arve0 wants to merge 1 commit into
nodejs:masterfrom
arve0:patch-1

Conversation

@arve0

@arve0arve0 commented May 7, 2016•
edited
Loading

Copy link
Copy Markdown
Contributor
Checklist
  • documentation is changed or added
  • the commit message follows commit guidelines
Affected core subsystem(s)

doc

Description of change

readline.emitKeypressEvents needs stream to be in raw mode, fixes#6626

@nodejs-github-botnodejs-github-bot added the doc Issues and PRs related to the documentations. label May 7, 2016
@addaleaxaddaleax added the readline Issues and PRs related to the built-in readline module. label May 7, 2016
@arve0arve0 changed the title expand documentation for readline.emitKeypressEventsdoc: readline.emitKeypressEvents and raw modeMay 7, 2016
Fishrock123
Fishrock123 reviewed May 7, 2016
View reviewed changes
Comment threaddoc/api/readline.md Outdated

@Fishrock123Fishrock123May 7, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

needs

@arve0arve0May 7, 2016

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks.

@jasnell

jasnell commented May 8, 2016

Copy link
Copy Markdown
Member

@nodejs/documentation

@arve0

arve0 commented May 8, 2016

Copy link
Copy Markdown
ContributorAuthor

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 processprocess.stdin.setRawMode(true)}

addaleax
addaleax reviewed May 12, 2016
View reviewed changes
Comment threaddoc/api/readline.md Outdated

@addaleaxaddaleaxMay 12, 2016

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

“… the stream, if it is a TTY, needs to be…”?

@addaleax

addaleax commented May 12, 2016

Copy link
Copy Markdown
Member

@arve0 +1 to adding that check to the example. LGTM apart from that.

@arve0
expand documentation for readline.emitKeypressEvents
efe7ccc
`readline.emitKeypressEvents` needs `stream` to be in raw mode, ref nodejs#6626
@arve0

arve0 commented May 12, 2016

Copy link
Copy Markdown
ContributorAuthor

Updated.

@r-52

r-52 commented May 12, 2016

Copy link
Copy Markdown
Contributor

LGTM

addaleax pushed a commit that referenced this pull request May 16, 2016
@arve0@addaleax
doc: readline.emitKeypressEvents and raw mode
1ba5a56
`readline.emitKeypressEvents` needs `stream` to be in raw mode.
PR-URL: #6628Fixes: #6626
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Roman Klauke <romaaan.git@gmail.com>
@addaleax

addaleax commented May 16, 2016

Copy link
Copy Markdown
Member

Landed in 1ba5a56. Thank you!

evanlucas pushed a commit that referenced this pull request May 17, 2016
@arve0@evanlucas
doc: readline.emitKeypressEvents and raw mode
2273971
`readline.emitKeypressEvents` needs `stream` to be in raw mode.
PR-URL: #6628Fixes: #6626
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Roman Klauke <romaaan.git@gmail.com>
@evanlucasevanlucas mentioned this pull request May 17, 2016
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

docIssues and PRs related to the documentations.readlineIssues and PRs related to the built-in readline module.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Document that readline.emitKeypressEvents only works when tty is in raw mode

7 participants

@arve0@jasnell@addaleax@r-52@Fishrock123@MylesBorins@nodejs-github-bot