Node.js v16.9.1 文档


目录

tty 终端#

中英对照

稳定性: 2 - 稳定

源代码: lib/tty.js

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

const tty = require('tty');

当 Node.js 检测到其运行时绑定了文本终端,则默认情况下,process.stdin 将被初始化为 tty.ReadStream 的实例,而 process.stdoutprocess.stderr 都将默认为 tty.WriteStream 的实例。 确定 Node.js 是否在终端上下文中运行的首选方法是检查 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#

中英对照

代表终端的可读端。 在正常情况下,process.stdin 将是 Node.js 进程中唯一的 tty.ReadStream 实例,应该没有理由创建额外的实例。

readStream.isRaw#

中英对照

boolean 值,如果终端当前配置为作为原始设备运行,则为 true。 默认为 false

readStream.isTTY#

中英对照

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

readStream.setRawMode(mode)#

中英对照

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

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

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

tty.WriteStream#

中英对照

代表终端的可写端。 在正常情况下,process.stdoutprocess.stderr 将是为 Node.js 进程创建的唯一的 tty.WriteStream 实例,应该没有理由创建额外的实例。

'resize' 事件#

中英对照

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

process.stdout.on('resize', () => {
  console.log('screen size has changed!');
  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#

中英对照

number 指定终端当前具有的列数。 每当触发 '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>

Returns:

  • 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 对应的终端的尺寸。 该数组的类型为 [numColumns, numRows],其中 numColumnsnumRows 表示相应终端中的列数和行数。

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

中英对照

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

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

这具有与 writeStream.getColorDepth() 中描述的相同的误报和漏报。

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

writeStream.isTTY#

中英对照

boolean 值,始终为 true

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

中英对照

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

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

writeStream.rows#

中英对照

number 指定终端当前具有的行数。 每当触发 'resize' 事件时,则会更新此属性。

tty.isatty(fd)#

中英对照

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