Node.js TTY


Node.js TTY

稳定性: 2 - 不稳定

Node.js的tty模块包含tty.ReadStream和tty.WriteStream类,多数情况下,你不必直接使用这个模块,访问该模块的方法如下:

const tty = require('tty');

当node检测到自己正运行于TTY上下文时,process.stdin将会是一个tty.ReadStream实例,并且process.stdout将会是tty.WriteStream实例。检测 node是否运行在TTY上下文的好方法是检测process.stdout.isTTY:

$ node -p -e "Boolean(process.stdout.isTTY)"
true
$ node -p -e "Boolean(process.stdout.isTTY)" | cat
false

tty.isatty(fd)

如果fd和终端相关联返回true,否则返回false。

tty.setRawMode(mode)

已经抛弃。使用tty.ReadStream#setRawMode()(比如process.stdin.setRawMode())替换。

Class: ReadStream

net.Socket的子类,表示tty的可读部分。通常情况,在任何node程序里(仅当isatty(0)为true时),process.stdin是tty.ReadStream的唯一实例。

rs.isRaw

Boolean值,默认为false。它代表当前tty.ReadStream实例的"raw"状态。

rs.setRawMode(mode)

mode需是true或false。它设定tty.ReadStream属性为原始设备或默认。isRaw将会设置为结果模式。

Class: WriteStream

net.Socket的子类,代表tty的可写部分。通常情况下,process.stdout是tty.WriteStream唯一实例(仅当isatty(1)为true时)。

ws.columns

TTY当前拥有的列数。触发"resize"事件时会更新这个值。

ws.rows

TTY当前拥有的行数。触发"resize"事件时会更新这个值。

Event: 'resize'

function () {} 行或列变化时会触发refreshSize()事件。

process.stdout.on('resize', function() {
  console.log('screen size has changed!');
  console.log(process.stdout.columns + 'x' + process.stdout.rows);
});