Commit 3d3263c
doc: add some info on tty#setRawMode()
Partially taken from https://linux.die.net/man/3/cfmakeraw
A very simple test script:
```
if (process.argv[2] === 'raw')
process.stdin.setRawMode(true)
process.stdin.on('data', (chunk) => {
console.log(chunk)
console.log(chunk.toString())
})
```
Refs: #10037
PR-URL: #10147
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>1 parent 29e7de9 commit 3d3263c
1 file changed
Lines changed: 7 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -50,6 +50,13 @@ raw device. Defaults to `false`. | |||
| 50 | 50 | added: v0.7.7 | |
| 51 | 51 | --> | |
| 52 | 52 | ||
| 53 | + Allows configuration of `tty.ReadStream` so that it operates as a raw device. | ||
| 54 | + | ||
| 55 | + When in raw mode, input is always available character-by-character, not | ||
| 56 | + including modifiers. Additionally, all special processing of characters by the | ||
| 57 | + terminal is disabled, including echoing input characters. | ||
| 58 | + Note that `CTRL`+`C` will no longer cause a `SIGINT` when in this mode. | ||
| 59 | + | ||
| 53 | 60 | * `mode` {boolean} If `true`, configures the `tty.ReadStream` to operate as a | |
| 54 | 61 | raw device. If `false`, configures the `tty.ReadStream` to operate in its | |
| 55 | 62 | default mode. The `readStream.isRaw` property will be set to the resulting | |
0 commit comments