Node.js v24.0.0 文档

readStream.isRaw#

如果 TTY 当前配置为作为原始设备运行，则为 boolean，其值为 true。

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

readStream.isTTY#

对于 tty.ReadStream 实例，boolean 始终为 true。

readStream.setRawMode(mode)#

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

允许配置 tty.ReadStream，以便它作为原始设备运行。

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

new tty.ReadStream(fd[, options])#

• fd <number> 与 TTY 关联的文件描述符。
• options <Object> 传递给父 net.Socket 的选项，请参阅 net.Socket 构造函数 的 options。
• 返回 <tty.ReadStream>

为与 TTY 关联的 fd 创建 ReadStream。

new tty.WriteStream(fd)#

• fd <number> 与 TTY 关联的文件描述符。
• 返回 <tty.WriteStream>

为与 TTY 关联的 fd 创建 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() 在由 dir 标识的方向上清除此 WriteStream 的当前行。

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#

一个 boolean，其值始终为 true。

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

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

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

writeStream.rows#

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