Skip to content
Closed
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
ecd2179
doc: sort assert alphabetically
tflanagan Nov 4, 2015
63a2e55
doc: sort buffer alphabetically
tflanagan Nov 4, 2015
7b4f78a
doc: sort child_process alphabetically
tflanagan Nov 4, 2015
e650680
doc: sort cluster alphabetically
tflanagan Nov 4, 2015
cfed942
doc: sort console alphabetically
tflanagan Nov 4, 2015
03dd92c
doc: sort dns alphabetically
tflanagan Nov 4, 2015
d9e5b6a
doc: sort crypto alphabetically
tflanagan Nov 4, 2015
43f2da0
doc: sort dgram alphabetically
tflanagan Nov 4, 2015
b85d3ac
doc: sort errors alphabetically
tflanagan Nov 4, 2015
03129f8
doc: sort events alphabetically
tflanagan Nov 4, 2015
c44523a
doc: sort fs alphabetically
tflanagan Nov 4, 2015
0c181d1
doc: sort globals alphabetically
tflanagan Nov 4, 2015
99c8160
doc: sort os alphabetically
tflanagan Nov 4, 2015
820506e
doc: sort path alphabetically
tflanagan Nov 4, 2015
33a6975
doc: sort punycode alphabetically
tflanagan Nov 4, 2015
5c37462
doc: sort querystring alphabetically
tflanagan Nov 4, 2015
ac62941
doc: sort vm alphabetically
tflanagan Nov 4, 2015
8c83054
doc: sort url alphabetically
tflanagan Nov 4, 2015
cc6f224
doc: sort tty alphabetically
tflanagan Nov 4, 2015
15a8370
doc: sort timers alphabetically
tflanagan Nov 4, 2015
da7afdc
doc: sort string_decoder alphabetically
tflanagan Nov 4, 2015
059c98a
doc: sort repl alphabetically
tflanagan Nov 4, 2015
7ccad23
doc: sort readline alphabetically
tflanagan Nov 4, 2015
89122ce
doc: sort modules alphabetically
tflanagan Nov 4, 2015
3595327
doc: sort http alphabetically
tflanagan Nov 4, 2015
bed67d2
doc: sort https alphabetically
tflanagan Nov 4, 2015
5b09a1c
doc: sort util alphabetically
tflanagan Nov 5, 2015
37d037b
doc: sort zlib alphabetically
tflanagan Nov 5, 2015
8dbd518
doc: sort process alphabetically
tflanagan Nov 5, 2015
9811315
doc: sort net alphabetically
tflanagan Nov 5, 2015
e8c1e06
doc: sort stream alphabetically
tflanagan Nov 5, 2015
1b86f37
doc: sort tls alphabetically
tflanagan Nov 5, 2015
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc: sort tty alphabetically
Reorders, with no contextual changes, the tty documentation
alphabetically.
  • Loading branch information
tflanagan committed Nov 5, 2015
commit cc6f224d268925168a47a5c500b8f92fad86325f
41 changes: 18 additions & 23 deletions doc/api/tty.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,6 @@ in a TTY context is to check `process.stdout.isTTY`:
$ node -p -e "Boolean(process.stdout.isTTY)" | cat
false


## tty.isatty(fd)

Returns `true` or `false` depending on if the `fd` is associated with a
terminal.


## tty.setRawMode(mode)

Stability: 0 - Deprecated: Use [tty.ReadStream#setRawMode][] (i.e. process.stdin.setRawMode) instead.


## Class: ReadStream

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

[tty.ReadStream#setRawMode]: #tty_rs_setrawmode_mode

## Class: WriteStream

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

### ws.columns

A `Number` that gives the number of columns the TTY currently has. This property
gets updated on "resize" events.

### ws.rows

A `Number` that gives the number of rows the TTY currently has. This property
gets updated on "resize" events.

### Event: 'resize'

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

### ws.columns

[tty.ReadStream#setRawMode]: #tty_rs_setrawmode_mode
A `Number` that gives the number of columns the TTY currently has. This property
gets updated on "resize" events.

### ws.rows

A `Number` that gives the number of rows the TTY currently has. This property
gets updated on "resize" events.

## tty.isatty(fd)

Returns `true` or `false` depending on if the `fd` is associated with a
terminal.

## tty.setRawMode(mode)

Stability: 0 - Deprecated: Use [tty.ReadStream#setRawMode][] (i.e. process.stdin.setRawMode) instead.