Skip to content

Commit 14b5a95

Browse files
tflanaganrvagg
authored andcommitted
doc: sort tty alphabetically
Reorders, with no contextual changes, the tty documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
1 parent d4dda77 commit 14b5a95

File tree

1 file changed

+18
-23
lines changed

1 file changed

+18
-23
lines changed

doc/api/tty.markdown

+18-23
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,6 @@ in a TTY context is to check `process.stdout.isTTY`:
1515
$ node -p -e "Boolean(process.stdout.isTTY)" | cat
1616
false
1717

18-
19-
## tty.isatty(fd)
20-
21-
Returns `true` or `false` depending on if the `fd` is associated with a
22-
terminal.
23-
24-
25-
## tty.setRawMode(mode)
26-
27-
Stability: 0 - Deprecated: Use [tty.ReadStream#setRawMode][] (i.e. process.stdin.setRawMode) instead.
28-
29-
3018
## Class: ReadStream
3119

3220
A `net.Socket` subclass that represents the readable portion of a tty. In normal
@@ -44,23 +32,14 @@ of the `tty.ReadStream` instance.
4432
`tty.ReadStream` to act either as a raw device or default. `isRaw` will be set
4533
to the resulting mode.
4634

35+
[tty.ReadStream#setRawMode]: #tty_rs_setrawmode_mode
4736

4837
## Class: WriteStream
4938

5039
A `net.Socket` subclass that represents the writable portion of a tty. In normal
5140
circumstances, `process.stdout` will be the only `tty.WriteStream` instance
5241
ever created (and only when `isatty(1)` is true).
5342

54-
### ws.columns
55-
56-
A `Number` that gives the number of columns the TTY currently has. This property
57-
gets updated on "resize" events.
58-
59-
### ws.rows
60-
61-
A `Number` that gives the number of rows the TTY currently has. This property
62-
gets updated on "resize" events.
63-
6443
### Event: 'resize'
6544

6645
`function () {}`
@@ -73,5 +52,21 @@ has changed.
7352
console.log(process.stdout.columns + 'x' + process.stdout.rows);
7453
});
7554

55+
### ws.columns
7656

77-
[tty.ReadStream#setRawMode]: #tty_rs_setrawmode_mode
57+
A `Number` that gives the number of columns the TTY currently has. This property
58+
gets updated on "resize" events.
59+
60+
### ws.rows
61+
62+
A `Number` that gives the number of rows the TTY currently has. This property
63+
gets updated on "resize" events.
64+
65+
## tty.isatty(fd)
66+
67+
Returns `true` or `false` depending on if the `fd` is associated with a
68+
terminal.
69+
70+
## tty.setRawMode(mode)
71+
72+
Stability: 0 - Deprecated: Use [tty.ReadStream#setRawMode][] (i.e. process.stdin.setRawMode) instead.

0 commit comments

Comments
 (0)