- assert断言
- async_hooks异步钩子
- async_hooks/context异步上下文
- buffer缓冲区
- C++插件
- C/C++插件(使用Node-API)
- C++嵌入器
- child_process子进程
- cluster集群
- CLI命令行
- console控制台
- Corepack核心包
- crypto加密
- crypto/webcrypto网络加密
- debugger调试器
- deprecation弃用
- dgram数据报
- diagnostics_channel诊断通道
- dns域名服务器
- domain域
- Error错误
- events事件触发器
- fs文件系统
- global全局变量
- http超文本传输协议
- http2超文本传输协议2.0
- https安全超文本传输协议
- inspector检查器
- Intl国际化
- module模块
- module/cjsCommonJS模块
- module/esmECMAScript模块
- module/package包模块
- net网络
- os操作系统
- path路径
- perf_hooks性能钩子
- permission权限
- policy安全策略
- process进程
- punycode域名代码
- querystring查询字符串
- readline逐行读取
- repl交互式解释器
- report诊断报告
- stream流
- stream/web网络流
- string_decoder字符串解码器
- test测试
- timers定时器
- tls安全传输层
- trace_events跟踪事件
- tty终端
- url网址
- util实用工具
- v8引擎
- vm虚拟机
- wasi网络汇编系统接口
- worker_threads工作线程
- zlib压缩
Node.js v16.18.1 文档
- Node.js 16.18.1
-
►
目录
- tty 终端
tty.ReadStream
类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 终端
-
►
索引
- assert 断言
- async_hooks 异步钩子
- async_hooks/context 异步上下文
- buffer 缓冲区
- C++插件
- C/C++插件(使用Node-API)
- C++嵌入器
- child_process 子进程
- cluster 集群
- CLI 命令行
- console 控制台
- Corepack 核心包
- crypto 加密
- crypto/webcrypto 网络加密
- debugger 调试器
- deprecation 弃用
- dgram 数据报
- diagnostics_channel 诊断通道
- dns 域名服务器
- domain 域
- Error 错误
- events 事件触发器
- fs 文件系统
- global 全局变量
- http 超文本传输协议
- http2 超文本传输协议2.0
- https 安全超文本传输协议
- inspector 检查器
- Intl 国际化
- module 模块
- module/cjs CommonJS模块
- module/esm ECMAScript模块
- module/package 包模块
- net 网络
- os 操作系统
- path 路径
- perf_hooks 性能钩子
- permission 权限
- policy 安全策略
- process 进程
- punycode 域名代码
- querystring 查询字符串
- readline 逐行读取
- repl 交互式解释器
- report 诊断报告
- stream 流
- stream/web 网络流
- string_decoder 字符串解码器
- test 测试
- timers 定时器
- tls 安全传输层
- trace_events 跟踪事件
- tty 终端
- url 网址
- util 实用工具
- v8 引擎
- vm 虚拟机
- wasi 网络汇编系统接口
- worker_threads 工作线程
- zlib 压缩
- ► 其他版本
- 文档搜索
目录
- tty 终端
tty.ReadStream
类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 终端#
源代码: lib/tty.js
node:tty
模块提供了 tty.ReadStream
和 tty.WriteStream
类。
在大多数情况下,没有必要或不可能直接使用此模块。
但是,可以使用以下方式访问它:
const tty = require('node:tty');
当 Node.js 检测到其运行时绑定了文本终端,则默认情况下,process.stdin
将被初始化为 tty.ReadStream
的实例,而 process.stdout
和 process.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.ReadStream
和 tty.WriteStream
类的实例。
tty.ReadStream
类#
- 继承自: <net.Socket>
代表终端的可读端。
在正常情况下,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
类#
- 继承自: <net.Socket>
代表终端的可写端。
在正常情况下,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}`);
});
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])
#
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_COLOR
和 NODE_DISABLE_COLORS
环境变量也可以禁用颜色支持。
writeStream.getWindowSize()
#
- 返回: <number[]>
writeStream.getWindowSize()
返回此 WriteStream
对应的终端的尺寸。
该数组的类型为 [numColumns, numRows]
,其中 numColumns
和 numRows
表示相应终端中的列数和行数。
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
不是非负整数时。