TTY

[稳定: 2 - 稳定]

源代码: lib/tty.js

node:tty 模块提供 tty.ReadStream 和 tty.WriteStream 类。在大多数情况下，不需要也不可能直接使用此模块。但是，可以使用以下方法访问它：

const tty = require('node:tty')

当 Node.js 检测到它正在使用连接的文本终端 (“TTY”) 运行时，process.stdin 默认情况下将被初始化为 tty.ReadStream 的实例，并且 process.stdout 和 process.stderr 默认情况下都将是 tty.WriteStream 的实例。确定 Node.js 是否在 TTY 环境中运行的首选方法是检查 process.stdout.isTTY 属性的值是否为 true：

bash

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

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

类: `tty.ReadStream`

新增于: v0.5.8

继承自: <net.Socket>

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

`readStream.isRaw`

新增于: v0.7.7

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

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

`readStream.isTTY`

新增于: v0.5.8

一个布尔值，对于 tty.ReadStream 实例始终为 true。

`readStream.setRawMode(mode)`

新增于: v0.7.7

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

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

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

类: `tty.WriteStream`

新增于: v0.5.8

继承自: <net.Socket>

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

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

[历史]

版本	变更
v0.9.4	支持 `options` 参数。
v0.5.8	新增于: v0.5.8

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

为与 TTY 关联的 fd 创建一个 ReadStream。

`new tty.WriteStream(fd)`

新增于：v0.5.8

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

创建一个与 TTY 关联的 fd 的 WriteStream。

事件：`'resize'`

新增于：v0.7.7

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

process.stdout.on('resize', () => {
  console.log('屏幕尺寸已更改！')
  console.log(`${process.stdout.columns}x${process.stdout.rows}`)
})

`writeStream.clearLine(dir[, callback])`

[历史]

版本	变更
v12.7.0	公开了流的 write() 回调函数和返回值。
v0.7.7	新增于：v0.7.7

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

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

`writeStream.clearScreenDown([callback])`

[历史]

版本	变更
v12.7.0	公开了流的 write() 回调函数和返回值。
v0.7.7	v0.7.7 版本中添加

callback <函数> 操作完成后调用。
返回值: <布尔值> 如果流希望调用代码等待 'drain' 事件发出后再继续写入其他数据，则返回 false；否则返回 true。

writeStream.clearScreenDown() 清除此 WriteStream 从当前光标到屏幕底部的内容。

`writeStream.columns`

v0.7.7 版本中添加

一个 number 类型的值，指定 TTY 当前的列数。每当发出 'resize' 事件时，此属性都会更新。

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

[历史]

版本	变更
v12.7.0	公开了流的 write() 回调函数和返回值。
v0.7.7	v0.7.7 版本中添加

x <数字>
y <数字>
callback <函数> 操作完成后调用。
返回值: <布尔值> 如果流希望调用代码等待 'drain' 事件发出后再继续写入其他数据，则返回 false；否则返回 true。

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

`writeStream.getColorDepth([env])`

新增于: v9.9.0

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()`

新增于：v0.7.7

返回值：<number[]>

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

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

新增于：v11.13.0, v10.16.0

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`

新增于：v0.5.8

一个始终为 true 的 boolean 值。

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

[历史]

版本	变更
v12.7.0	公开了流的 write() 回调函数和返回值。
v0.7.7	新增于：v0.7.7

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

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

`writeStream.rows`

新增于：v0.7.7

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

`tty.isatty(fd)`

新增于：v0.5.8

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

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

TTY ​

类: tty.ReadStream ​

readStream.isRaw ​

readStream.isTTY ​

readStream.setRawMode(mode) ​

类: tty.WriteStream ​

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

new tty.WriteStream(fd) ​

事件：'resize' ​

writeStream.clearLine(dir[, callback]) ​

writeStream.clearScreenDown([callback]) ​

writeStream.columns ​

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

writeStream.getColorDepth([env]) ​

writeStream.getWindowSize() ​

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

writeStream.isTTY ​

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

writeStream.rows ​

tty.isatty(fd) ​

TTY

类: `tty.ReadStream`

`readStream.isRaw`

`readStream.isTTY`

`readStream.setRawMode(mode)`

类: `tty.WriteStream`

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

`new tty.WriteStream(fd)`

事件：`'resize'`

`writeStream.clearLine(dir[, callback])`

`writeStream.clearScreenDown([callback])`

`writeStream.columns`

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

`writeStream.getColorDepth([env])`

`writeStream.getWindowSize()`

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

`writeStream.isTTY`

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

`writeStream.rows`

`tty.isatty(fd)`