tty 终端 | Node.js API 文档

Node.js 中文网

tty 终端

tty 终端#

中英对照

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

`tty.ReadStream` 类#

中英对照

新增于: v0.5.8

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

`readStream.isRaw`#

中英对照

新增于: v0.7.7

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

`readStream.isTTY`#

中英对照

新增于: v0.5.8

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

`readStream.setRawMode(mode)`#

中英对照

新增于: v0.7.7

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

`tty.WriteStream` 类#

中英对照

新增于: v0.5.8

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

`'resize'` 事件#

中英对照

新增于: v0.7.7

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

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

中英对照

版本历史

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

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

`writeStream.clearScreenDown([callback])`#

中英对照

版本历史

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

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

`writeStream.columns`#

中英对照

新增于: v0.7.7

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

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

中英对照

版本历史

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

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

`writeStream.getColorDepth([env])`#

中英对照

新增于: v9.9.0

Returns:

`writeStream.getWindowSize()`#

中英对照

新增于: v0.7.7

writeStream.getWindowSize() 返回此 WriteStream 对应的终端的尺寸。该数组的类型为 [numColumns, numRows]，其中 numColumns 和 numRows 表示相应终端中的列数和行数。

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

中英对照

新增于: v11.13.0, v10.16.0

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

`writeStream.isTTY`#

中英对照

新增于: v0.5.8

boolean 值，始终为 true。

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

中英对照

版本历史

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

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

`writeStream.rows`#

中英对照

新增于: v0.7.7

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

`tty.isatty(fd)`#

中英对照

新增于: v0.5.8

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

tty 终端#

tty.ReadStream 类#

readStream.isRaw#

readStream.isTTY#

readStream.setRawMode(mode)#

tty.WriteStream 类#

'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.ReadStream` 类#

`readStream.isRaw`#

`readStream.isTTY`#

`readStream.setRawMode(mode)`#

`tty.WriteStream` 类#

`'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)`#