Node.js v21.7.2 文档

类: tty.ReadStream#

• 扩展: <net.Socket>

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

readStream.isRaw#

一个 boolean 值，如果 TTY 当前配置为以原始设备模式运行，则为 true。

即使终端以原始模式运行，此标志在进程启动时始终为 false。它的值将在后续调用 setRawMode 时更改。

readStream.isTTY#

一个始终为 true 的 boolean 值，用于 tty.ReadStream 实例。

readStream.setRawMode(mode)#

• mode <boolean> 如果为 true，则将 tty.ReadStream 配置为以原始设备模式运行。如果为 false，则将 tty.ReadStream 配置为以默认模式运行。readStream.isRaw 属性将设置为最终的模式。
• 返回值：<this> 读取流实例。

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

在原始模式下，输入始终以逐字符的方式提供，不包括修饰符。此外，终端对字符的所有特殊处理都将被禁用，包括回显输入字符。在该模式下，Ctrl+C 将不再导致 SIGINT。

类：tty.WriteStream#

• 扩展: <net.Socket>

表示 TTY 的可写端。在正常情况下，process.stdout 和 process.stderr 将是为 Node.js 进程创建的唯一 tty.WriteStream 实例，并且没有理由创建额外的实例。

事件：'resize'#

只要 writeStream.columns 或 writeStream.rows 属性发生更改，就会发出 'resize' 事件。调用监听器回调时，不会传递任何参数。

process.stdout.on('resize', () => {
  console.log('screen size has changed!');
  console.log(`${process.stdout.columns}x${process.stdout.rows}`);
}); copy

writeStream.clearLine(dir[, callback])#

• dir <number>
  • -1：从光标向左
  • 1：从光标向右
  • 0：整行
• callback <Function> 操作完成后调用。
• 返回值：<boolean> 如果流希望调用代码等待 'drain' 事件发出后再继续写入更多数据，则为 false；否则为 true。

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

writeStream.clearScreenDown([callback])#

• callback <Function> 操作完成后调用。
• 返回值：<boolean> 如果流希望调用代码等待 'drain' 事件发出后再继续写入更多数据，则为 false；否则为 true。

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

writeStream.columns#

一个 number，指定 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_COLOR 和 NODE_DISABLE_COLORS 环境变量来禁用颜色支持。

writeStream.getWindowSize()#

• 返回值：<number[]>

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

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

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

如果 writeStream 支持至少与 count 中提供的颜色数量一样多的颜色，则返回 true。最小支持为 2 种颜色（黑色和白色）。

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

process.stdout.hasColors();
// Returns true or false depending on if `stdout` supports at least 16 colors.
process.stdout.hasColors(256);
// Returns true or false depending on if `stdout` supports at least 256 colors.
process.stdout.hasColors({ TMUX: '1' });
// Returns true.
process.stdout.hasColors(2 ** 24, { TMUX: '1' });
// Returns false (the environment setting pretends to support 2 ** 8 colors). copy

writeStream.isTTY#

一个始终为true的boolean值。

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

• dx <number>
• dy <number>
• callback <Function> 操作完成后调用。
• 返回值：<boolean> 如果流希望调用代码等待 'drain' 事件发出后再继续写入更多数据，则为 false；否则为 true。

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

writeStream.rows#

一个number，指定 TTY 当前拥有的行数。每当发出'resize' 事件时，此属性都会更新。

tty.isatty(fd)#

• fd <number> 一个数字文件描述符
• 返回值：<boolean>

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