Skip to content

doc: setRawMode needs write permission on Windows #63856

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

Open
edemaine wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −0
Open

doc: setRawMode needs write permission on Windows #63856

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
6 changes: 6 additions & 0 deletions doc/api/tty.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,11 @@ characters. <kbd>Ctrl</kbd>+<kbd>C</kbd> will no longer cause a `SIGINT` when
in this mode. This mode does not affect terminal output processing, such as
newline translation on Unix terminals.

On Windows, `setRawMode()` requires write permission to the console input
buffer. When opening `"\\\\.\\CONIN$"` with the [`fs.open()`][] family of APIs
(for passing into `new tty.ReadStream()`), be sure to use a read/write flag
such as `'r+'`.

## Class: `tty.WriteStream`

<!-- YAML
Expand Down Expand Up @@ -342,6 +347,7 @@ The `tty.isatty()` method returns `true` if the given `fd` is associated with
a TTY and `false` if it is not, including whenever `fd` is not a non-negative
integer.

[`fs.open()`]: fs.md#fsopenpath-flags-mode-callback
[`net.Socket` constructor]: net.md#new-netsocketoptions
[`process.stderr`]: process.md#processstderr
[`process.stdin`]: process.md#processstdin
Expand Down
Loading