From 1511da076c1893e4626b775deb42a5fce4944f58 Mon Sep 17 00:00:00 2001 From: Erik Demaine Date: Thu, 11 Jun 2026 14:05:58 -0400 Subject: [PATCH] doc: document setRawMode write access on Windows Fixes: https://github.com/nodejs/node/issues/63852 Signed-off-by: Erik Demaine --- doc/api/tty.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/api/tty.md b/doc/api/tty.md index 03f86cd66052fd..cbfb3cc783772d 100644 --- a/doc/api/tty.md +++ b/doc/api/tty.md @@ -86,6 +86,11 @@ characters. Ctrl+C 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`