diff options
| author | Sam Ruby <rubys@intertwingly.net> | 2018-07-12 20:48:11 +0300 |
|---|---|---|
| committer | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-07-15 23:57:35 +0300 |
| commit | 40c85ff0634913f4c61e13cbb7cacb7e2c76120f (patch) | |
| tree | 242febebcaa984898e65cdcd6bd61d6f6c1e4fed /doc/api/tty.md | |
| parent | 1009118d27b069411016df4ca6915aac3c36a41f (diff) | |
doc: declare all parameter types
PR-URL: https://github.com/nodejs/node/pull/21782
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Diffstat (limited to 'doc/api/tty.md')
| -rw-r--r-- | doc/api/tty.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/api/tty.md b/doc/api/tty.md index 91bca8284d9..cc95bfa9ae8 100644 --- a/doc/api/tty.md +++ b/doc/api/tty.md @@ -60,6 +60,11 @@ A `boolean` that is always `true` for `tty.ReadStream` instances. added: v0.7.7 --> +* `mode` {boolean} If `true`, configures the `tty.ReadStream` to operate as a + raw device. If `false`, configures the `tty.ReadStream` to operate in its + default mode. The `readStream.isRaw` property will be set to the resulting + mode. + Allows configuration of `tty.ReadStream` so that it operates as a raw device. When in raw mode, input is always available character-by-character, not @@ -67,11 +72,6 @@ including modifiers. Additionally, all special processing of characters by the terminal is disabled, including echoing input characters. Note that `CTRL`+`C` will no longer cause a `SIGINT` when in this mode. -* `mode` {boolean} If `true`, configures the `tty.ReadStream` to operate as a - raw device. If `false`, configures the `tty.ReadStream` to operate in its - default mode. The `readStream.isRaw` property will be set to the resulting - mode. - ## Class: tty.WriteStream <!-- YAML added: v0.5.8 |