1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
# TTY
<!--introduced_in=v0.10.0-->
> Stability: 2 - Stable
The `tty` module provides the `tty.ReadStream` and `tty.WriteStream` classes.
In most cases, it will not be necessary or possible to use this module directly.
However, it can be accessed using:
```js
const tty = require('tty');
```
When Node.js detects that it is being run inside a text terminal ("TTY")
context, the `process.stdin` will, by default, be initialized as an instance of
`tty.ReadStream` and both `process.stdout` and `process.stderr` will, by
default be instances of `tty.WriteStream`. The preferred method of determining
whether Node.js is being run within a TTY context is to check that the value of
the `process.stdout.isTTY` property is `true`:
```sh
$ node -p -e "Boolean(process.stdout.isTTY)"
true
$ node -p -e "Boolean(process.stdout.isTTY)" | cat
false
```
In most cases, there should be little to no reason for an application to
create instances of the `tty.ReadStream` and `tty.WriteStream` classes.
## Class: tty.ReadStream
<!-- YAML
added: v0.5.8
-->
The `tty.ReadStream` class is a subclass of `net.Socket` that represents the
readable side of a TTY. In normal circumstances `process.stdin` will be the
only `tty.ReadStream` instance in a Node.js process and there should be no
reason to create additional instances.
### readStream.isRaw
<!-- YAML
added: v0.7.7
-->
A `boolean` that is `true` if the TTY is currently configured to operate as a
raw device. Defaults to `false`.
### readStream.isTTY
<!-- YAML
added: v0.5.8
-->
A `boolean` that is always `true`.
### readStream.setRawMode(mode)
<!-- YAML
added: v0.7.7
-->
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
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
-->
The `tty.WriteStream` class is a subclass of `net.Socket` that represents the
writable side of a TTY. In normal circumstances, `process.stdout` and
`process.stderr` will be the only `tty.WriteStream` instances created for a
Node.js process and there should be no reason to create additional instances.
### Event: 'resize'
<!-- YAML
added: v0.7.7
-->
The `'resize'` event is emitted whenever either of the `writeStream.columns`
or `writeStream.rows` properties have changed. No arguments are passed to the
listener callback when called.
```js
process.stdout.on('resize', () => {
console.log('screen size has changed!');
console.log(`${process.stdout.columns}x${process.stdout.rows}`);
});
```
### writeStream.columns
<!-- YAML
added: v0.7.7
-->
A `number` specifying the number of columns the TTY currently has. This property
is updated whenever the `'resize'` event is emitted.
### writeStream.isTTY
<!-- YAML
added: v0.5.8
-->
A `boolean` that is always `true`.
### writeStream.rows
<!-- YAML
added: v0.7.7
-->
A `number` specifying the number of rows the TTY currently has. This property
is updated whenever the `'resize'` event is emitted.
## tty.isatty(fd)
<!-- YAML
added: v0.5.8
-->
* `fd` {number} A numeric file descriptor
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.
|
