- 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 v18.15.0 文档
- Node.js 18.15.0
- ► 目录
-
►
索引
- 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 压缩
- ► 其他版本
- 文档搜索
关于本文档#
欢迎使用 Node.js 的官方 API 参考文档！
Node.js 是一个基于 V8 JavaScript 引擎构建的 JavaScript 运行时。
参与贡献#
稳定性指数#
在文档中都有章节稳定性的标志。 有些 API 已被证明和依赖，因此它们几乎不可能改变。 有些则是全新的和实验的、或者已知是危险的。
稳定性指数如下：
稳定性: 0 - 弃用。
该特性可能会触发警告。
不保证向后的兼容性。
稳定性: 1 - 实验。
该特性不受语义版本控制规范的约束。
在任何未来的版本中都可能发生非向后兼容的更改或删除。
不建议在生产环境中使用该特性。
Stability: 2 - 稳定。
与 npm 生态系统的兼容性是重中之重。
稳定性: 3 - 旧版。
尽管此特性不太可能被删除并且仍由语义版本控制保证覆盖，
但它不再被积极维护，
并且有其他替代方案可用。
如果特性的使用没有害处并且其在 npm 生态系统中被广泛依赖，则标记为旧版而不是弃用。 旧版特性中发现的缺陷不太可能被修复。
当使用实验的特性时要小心，尤其是在模块中。 用户可能不知道正在使用实验的特性。 当实验的 API 发生修改时，故障或行为的变化可能会让用户感到诧异。 为避免诧异，使用实验的特性可能需要命令行标志。 实验的特性也可能触发警告。
稳定性概览#
| API | 稳定性 |
|---|---|
| assert | (2) 稳定 |
| async_context | (2) 稳定 |
| async_hooks | (1) 实验 |
| buffer | (2) 稳定 |
| child_process | (2) 稳定 |
| cluster | (2) 稳定 |
| console | (2) 稳定 |
| corepack | (1) 实验 |
| crypto | (2) 稳定 |
| debugger | (2) 稳定 |
| dgram | (2) 稳定 |
| diagnostics_channel | (2) 稳定 |
| dns | (2) 稳定 |
| domain | (0) 弃用 |
| events | (2) 稳定 |
| fs | (2) 稳定 |
| http | (2) 稳定 |
| http2 | (2) 稳定 |
| https | (2) 稳定 |
| inspector | (2) 稳定 |
| modules | (2) 稳定 |
| n-api | (2) 稳定 |
| net | (2) 稳定 |
| os | (2) 稳定 |
| path | (2) 稳定 |
| perf_hooks | (2) 稳定 |
| permissions | (1) 实验 |
| policy | (1) 实验 |
| punycode | (0) 弃用 |
| querystring | (2) 稳定 |
| readline | (2) 稳定 |
| repl | (2) 稳定 |
| report | (2) 稳定 |
| stream | (2) 稳定 |
| string_decoder | (2) 稳定 |
| test | (1) 实验 |
| timers | (2) 稳定 |
| tls | (2) 稳定 |
| tracing | (1) 实验 |
| tty | (2) 稳定 |
| url | (2) 稳定 |
| util | (2) 稳定 |
| vm | (2) 稳定 |
| wasi | (1) 实验 |
| webstreams | (1) 实验 |
| worker_threads | (2) 稳定 |
| zlib | (2) 稳定 |
JSON 输出#
每个 .html 文档都有对应的 .json 文档。
这适用于使用该文档的 IDE 和其他实用工具。
系统调用与帮助手册#
封装系统调用的 Node.js 函数会在文档中描述。 文档链接到对应的描述该系统调用的工作方式的帮助手册。
大多数 Unix 系统调用都有 Windows 类似物。 尽管如此，行为的差异可能是不可避免的。