doc: setRawMode needs write permission on Windows - #63856
Merged
Conversation
nodejs-github-bot
added
doc
This was referenced Jun 12, 2026
StefanStojanovic
approved these changes
Jul 2, 2026
Fixes: nodejs#63852 Signed-off-by: Erik Demaine <edemaine@mit.edu>
trivikr
approved these changes
Jul 21, 2026
trivikr
added
the
commit-queue
Collaborator
|
Landed in 16c06b8 |
nodejs-github-bot
removed
the
commit-queue
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Fixes #63852. After reporting that issue, I realized that this is probably how Windows is supposed to work, and I just needed to open the console with better permissions. This PR documents this solution so that others can figure this out more easily.
Summary of changes
Document that
tty.ReadStream#setRawMode()on Windows requires write access to the console input buffer.When opening
"\\\\.\\CONIN$"with thefs.open()family of APIs, a read-only flag such as'r'allows creating a readable TTY stream, butsetRawMode()fails because Windows needs write permission to update the console mode. Recommend using a read/write flag such as'r+'.