doc: clarify tty raw mode applies to input processing only · nodejs/node@fd74eef · GitHub

nodejs / node Public

• Notifications You must be signed in to change notification settings
• Fork 36.6k
• Star 120k

• Code
• Issues 635
• Pull requests 755
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit fd74eef

Browse filesBrowse the repository at this point in the historyBrowse files

zeeshan56656

authored and

aduh95

committed

doc: clarify tty raw mode applies to input processing only

Update the setRawMode documentation to specify that raw mode disables special processing of input characters only. Output processing, such as newline translation on Unix terminals, is not affected. Fixes: #63059 Signed-off-by: zeeshan56656 <zeeshan130710@gmail.com> PR-URL: #63438 Reviewed-By: Anna Henningsen <anna@addaleax.net>

1 parent 858496b commit fd74eef
Copy full SHA for fd74eef

1 file changed

+4-3Lines changed: 4 additions & 3 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• doc/api
  • tty.md

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎doc/api/tty.md‎

Copy file name to clipboardExpand all lines: doc/api/tty.md

+4-3Lines changed: 4 additions & 3 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -80,10 +80,11 @@ added: v0.7.7
80	80	Allows configuration of `tty.ReadStream` so that it operates as a raw device.
81	81
82	82	When in raw mode, input is always available character-by-character, not
83		- including modifiers. Additionally, all special processing of characters by the
84		- terminal is disabled, including echoing input
	83	+ including modifiers. Additionally, all special processing of input characters
	84	+ by the terminal is disabled, including echoing input
85	85	characters. <kbd>Ctrl</kbd>+<kbd>C</kbd> will no longer cause a `SIGINT` when
86		- in this mode.
	86	+ in this mode. This mode does not affect terminal output processing, such as
	87	+ newline translation on Unix terminals.
87	88
88	89	## Class: `tty.WriteStream`
89	90

0 commit comments

Comments

0 (0)