Node.js v12.9.0 文档


tty(终端)#

中英对照提交修改

稳定性: 2 - 稳定

tty 模块提供 tty.ReadStreamtty.WriteStream 类。 在大多数情况下,没有必要或可能直接使用此模块。 可以使用以下方法访问它:

const tty = require('tty');

当 Node.js 检测到它附加了文本终端(TTY)时,默认情况下,process.stdin 将被初始化为 tty.ReadStream 的一个实例,process.stdoutprocess.stderr 将被初始化为 tty.WriteStream 的实例。 判断 Node.js 是否在 TTY 上下文中运行的首选方法是检查 process.stdout.isTTY 属性的值是否为 true

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

在大多数情况下,应用程序应该几乎没有理由手动创建 tty.ReadStreamtty.WriteStream 类的实例。

tty.ReadStream 类#

中英对照提交修改

tty.ReadStream 类是 net.Socket 的子类,表示 TTY 的可读端。 在正常情况下,process.stdin 将是 Node.js 进程中唯一的 tty.ReadStream 实例,并且没有理由创建其他实例。

readStream.isRaw#

中英对照提交修改

布尔值,如果 TTY 当前配置为作为原始设备运行,则为 true。 默认为 false

readStream.isTTY#

中英对照提交修改

布尔值,对于 tty.ReadStream 实例始终为 true

readStream.setRawMode(mode)#

中英对照提交修改

  • mode <boolean> 如果为 true,则将 tty.ReadStream 配置为作为原始设备运行。 如果为 false,则将 tty.ReadStream 配置为以其默认模式运行。 readStream.isRaw 属性将设置为结果模式。
  • 返回: <this> - 读取流实例。

允许配置 tty.ReadStream,使其作为原始设备运行。

在原始模式下,输入始终可用于逐个字符,不包括修饰符。 此外,终端对字符的所有特殊处理都被禁用,包括回显输入字符。 注意,在此模式下, CTRL+C 将不再导致 SIGINT

tty.WriteStream 类#

中英对照提交修改

tty.WriteStream 类是 net.Socket 的子类,表示 TTY 的可写端。 在正常情况下,process.stdoutprocess.stderr 将是为 Node.js 进程创建的唯一 tty.WriteStream 实例,并且没有理由创建其他实例。

'resize' 事件#

中英对照提交修改

只要 writeStream.columnswriteStream.rows 属性发生更改,就会触发 'resize' 事件。 调用时,没有参数传递给监听器回调。

process.stdout.on('resize', () => {
  console.log('屏幕大小已经改变');
  console.log(`${process.stdout.columns}x${process.stdout.rows}`);
});

writeStream.clearLine(dir[, callback])#

中英对照提交修改

  • dir <number>

    • -1 - 从光标向左。
    • 1 - 从光标向右。
    • 0 - 整行。
  • callback <Function> 操作完成后调用。
  • 返回: <boolean> 如果流希望调用的代码在继续写入附加的数据之前等待 'drain' 事件触发,则为 false,否则为 true

writeStream.clearLine()dir 标识的方向上清除此 WriteStream 的当前行。

writeStream.clearScreenDown([callback])#

中英对照提交修改

  • callback <Function> 操作完成后调用。
  • 返回: <boolean> 如果流希望调用的代码在继续写入附加的数据之前等待 'drain' 事件触发,则为 false,否则为 true

writeStream.clearScreenDown() 从当前光标向下清除此 WriteStream

writeStream.columns#

中英对照提交修改

一个数字,指定 TTY 当前具有的列数。 每当触发 'resize' 事件时,此属性都会更新。

writeStream.cursorTo(x[, y][, callback])#

中英对照提交修改

  • x <number>
  • y <number>
  • callback <Function> 操作完成后调用。
  • 返回: <boolean> 如果流希望调用的代码在继续写入附加的数据之前等待 'drain' 事件触发,则为 false,否则为 true

writeStream.cursorTo()WriteStream 的光标移动到指定的位置。

writeStream.getColorDepth([env])#

中英对照提交修改

  • env <Object> 包含需要检查的环境变量的对象。这使得能够模拟特定终端的使用。默认值: process.env
  • 返回: <number>

返回:

  • 1 支持 2 种颜色,
  • 4 支持 16 种颜色,
  • 8 支持 256 种颜色,
  • 24 支持 16,777,216 种颜色,

使用此函数可检测终端支持的颜色。 鉴于终端中颜色的特性,可能存在假的正数或假的负数。 这取决于进程信息与环境变量(可能会隐瞒使用的终端)。 可以传入 env 对象来模拟特定终端的使用。 这对于检查特定环境设置的行为方式非常有用。

要强制执行特定的颜色支持,则使用以下环境设置之一。

  • 2 种颜色: FORCE_COLOR = 0 (禁用颜色)
  • 16 种颜色: FORCE_COLOR = 1
  • 256 种颜色: FORCE_COLOR = 2
  • 16,777,216 种颜色: FORCE_COLOR = 3

使用 NO_COLORNODE_DISABLE_COLORS 环境变量也可以禁用颜色支持。

writeStream.getWindowSize()#

中英对照提交修改

writeStream.getWindowSize() 返回与此 WriteStream 对应的 TTY 的大小。 该数组的类型为 [numColumns, numRows],其中 numColumnsnumRows 表示相应 TTY 中的列数和行数。

writeStream.hasColors([count][, env])#

中英对照提交修改

  • count <integer> 请求的颜色数量(最少2个)。默认值: 16。
  • env <Object> 包含需要检查的环境变量的对象。这使得能够模拟特定终端的使用。默认值: process.env
  • 返回: <boolean>

如果 writeStream 支持至少与 count 中提供的颜色一样多,则返回 true。 最低支持为 2(黑色和白色)。

这与 writeStream.getColorDepth() 中描述的假的正数或假的负数相同。

process.stdout.hasColors();
// 返回 true 或 false,取决于 `stdout` 是否支持至少 16 种颜色。
process.stdout.hasColors(256);
// 返回 true 或 false,取决于 `stdout` 是否支持至少 256 种颜色。
process.stdout.hasColors({ TMUX: '1' });
// 返回 true。
process.stdout.hasColors(2 ** 24, { TMUX: '1' });
// 返回 false (环境设置假设支持 2 ** 8 种颜色)。

writeStream.isTTY#

中英对照提交修改

布尔值,始终为 true

writeStream.moveCursor(dx, dy[, callback])#

中英对照提交修改

  • dx <number>
  • dy <number>
  • callback <Function> 操作完成后调用。
  • 返回: <boolean> 如果流希望调用的代码在继续写入附加的数据之前等待 'drain' 事件触发,则为 false,否则为 true

writeStream.moveCursor()WriteStream 的光标相对于其当前位置移动。

writeStream.rows#

中英对照提交修改

一个数字,指定 TTY 当前具有的行数。 每当触发 'resize' 事件时,此属性都会更新。

tty.isatty(fd)#

中英对照提交修改

如果给定的 fd 与 TTY 相关联,则 tty.isatty() 方法返回 true,否则返回 false,包括 fd 不是非负整数时。