@@ -30,7 +30,7 @@ In most cases, there should be little to no reason for an application to
30
30
manually create instances of the ` tty.ReadStream ` and ` tty.WriteStream `
31
31
classes.
32
32
33
- ## Class: tty.ReadStream
33
+ ## Class: ` tty.ReadStream `
34
34
<!-- YAML
35
35
added: v0.5.8
36
36
-->
@@ -41,22 +41,22 @@ Represents the readable side of a TTY. In normal circumstances
41
41
[ ` process.stdin ` ] [ ] will be the only ` tty.ReadStream ` instance in a Node.js
42
42
process and there should be no reason to create additional instances.
43
43
44
- ### readStream.isRaw
44
+ ### ` readStream.isRaw `
45
45
<!-- YAML
46
46
added: v0.7.7
47
47
-->
48
48
49
49
A ` boolean ` that is ` true ` if the TTY is currently configured to operate as a
50
50
raw device. Defaults to ` false ` .
51
51
52
- ### readStream.isTTY
52
+ ### ` readStream.isTTY `
53
53
<!-- YAML
54
54
added: v0.5.8
55
55
-->
56
56
57
57
A ` boolean ` that is always ` true ` for ` tty.ReadStream ` instances.
58
58
59
- ### readStream.setRawMode(mode)
59
+ ### ` readStream.setRawMode(mode) `
60
60
<!-- YAML
61
61
added: v0.7.7
62
62
-->
@@ -74,7 +74,7 @@ including modifiers. Additionally, all special processing of characters by the
74
74
terminal is disabled, including echoing input characters.
75
75
` CTRL ` +` C ` will no longer cause a ` SIGINT ` when in this mode.
76
76
77
- ## Class: tty.WriteStream
77
+ ## Class: ` tty.WriteStream `
78
78
<!-- YAML
79
79
added: v0.5.8
80
80
-->
@@ -86,7 +86,7 @@ Represents the writable side of a TTY. In normal circumstances,
86
86
` tty.WriteStream ` instances created for a Node.js process and there
87
87
should be no reason to create additional instances.
88
88
89
- ### Event: 'resize'
89
+ ### Event: ` 'resize' `
90
90
<!-- YAML
91
91
added: v0.7.7
92
92
-->
@@ -102,7 +102,7 @@ process.stdout.on('resize', () => {
102
102
});
103
103
```
104
104
105
- ### writeStream.clearLine(dir\ [ , callback\] )
105
+ ### ` writeStream.clearLine(dir[, callback]) `
106
106
<!-- YAML
107
107
added: v0.7.7
108
108
changes:
@@ -123,7 +123,7 @@ changes:
123
123
` writeStream.clearLine() ` clears the current line of this ` WriteStream ` in a
124
124
direction identified by ` dir ` .
125
125
126
- ### writeStream.clearScreenDown(\ [ callback\] )
126
+ ### ` writeStream.clearScreenDown([callback]) `
127
127
<!-- YAML
128
128
added: v0.7.7
129
129
changes:
@@ -140,15 +140,15 @@ changes:
140
140
` writeStream.clearScreenDown() ` clears this ` WriteStream ` from the current
141
141
cursor down.
142
142
143
- ### writeStream.columns
143
+ ### ` writeStream.columns `
144
144
<!-- YAML
145
145
added: v0.7.7
146
146
-->
147
147
148
148
A ` number ` specifying the number of columns the TTY currently has. This property
149
149
is updated whenever the ` 'resize' ` event is emitted.
150
150
151
- ### writeStream.cursorTo(x\ [ , y\]\ [ , callback\] )
151
+ ### ` writeStream.cursorTo(x[, y] [, callback]) `
152
152
<!-- YAML
153
153
added: v0.7.7
154
154
changes:
@@ -167,7 +167,7 @@ changes:
167
167
` writeStream.cursorTo() ` moves this ` WriteStream ` 's cursor to the specified
168
168
position.
169
169
170
- ### writeStream.getColorDepth(\ [ env\] )
170
+ ### ` writeStream.getColorDepth([env]) `
171
171
<!-- YAML
172
172
added: v9.9.0
173
173
-->
@@ -202,7 +202,7 @@ To enforce a specific color support, use one of the below environment settings.
202
202
Disabling color support is also possible by using the ` NO_COLOR ` and
203
203
` NODE_DISABLE_COLORS ` environment variables.
204
204
205
- ### writeStream.getWindowSize()
205
+ ### ` writeStream.getWindowSize() `
206
206
<!-- YAML
207
207
added: v0.7.7
208
208
-->
@@ -214,7 +214,7 @@ corresponding to this `WriteStream`. The array is of the type
214
214
` [numColumns, numRows] ` where ` numColumns ` and ` numRows ` represent the number
215
215
of columns and rows in the corresponding [ TTY] ( tty.html ) .
216
216
217
- ### writeStream.hasColors(\ [ count\]\ [ , env\] )
217
+ ### ` writeStream.hasColors([count] [, env]) `
218
218
<!-- YAML
219
219
added: v11.13.0
220
220
-->
@@ -243,14 +243,14 @@ process.stdout.hasColors(2 ** 24, { TMUX: '1' });
243
243
// Returns false (the environment setting pretends to support 2 ** 8 colors).
244
244
```
245
245
246
- ### writeStream.isTTY
246
+ ### ` writeStream.isTTY `
247
247
<!-- YAML
248
248
added: v0.5.8
249
249
-->
250
250
251
251
A ` boolean ` that is always ` true ` .
252
252
253
- ### writeStream.moveCursor(dx, dy\ [ , callback\] )
253
+ ### ` writeStream.moveCursor(dx, dy[, callback]) `
254
254
<!-- YAML
255
255
added: v0.7.7
256
256
changes:
@@ -269,15 +269,15 @@ changes:
269
269
` writeStream.moveCursor() ` moves this ` WriteStream ` 's cursor * relative* to its
270
270
current position.
271
271
272
- ### writeStream.rows
272
+ ### ` writeStream.rows `
273
273
<!-- YAML
274
274
added: v0.7.7
275
275
-->
276
276
277
277
A ` number ` specifying the number of rows the TTY currently has. This property
278
278
is updated whenever the ` 'resize' ` event is emitted.
279
279
280
- ## tty.isatty(fd)
280
+ ## ` tty.isatty(fd) `
281
281
<!-- YAML
282
282
added: v0.5.8
283
283
-->
0 commit comments