- 断言测试
- 异步上下文跟踪
- 异步钩子
- 缓冲(Buffer)
- C++ 插件
- 使用 Node-API 的 C/C++ 插件
- C++ 嵌入 Node环境
- 子进程(Child processes)
- 集群(Cluster)
- 命令行选项
- 控制台(Console)
- 核心包(Corepack)
- 加密(Crypto)
- 调试器(Debugger)
- 已弃用的 API
- 诊断通道(Diagnostics Channel)
- 域名系统(DNS)
- 域(Domain)
- 错误(Errors)
- 事件(Events)
- 文件系统(File system)
- 全局变量(Globals)
- HTTP
- HTTP/2
- HTTPS
- 检查器(Inspector)
- 国际化
- 模块：CommonJS 模块
- 模块：ECMAScript 模块
- 模块：
node:moduleAPI - 模块：packages 模块
- 网络(Net)
- 系统(OS)
- 路径(Path)
- 性能挂钩(Performance hooks)
- 性能挂钩(Permissions)
- 进程(Process)
- Punycode 国际化域名编码
- 查询字符串(Query strings)
- 命令行库(Readline)
- REPL 交互式编程环境
- 诊断报告
- 单个可执行应用程序
- Stream 流
- 字符串解码器
- 单元测试
- 定时器(Timers)
- 传输层安全/SSL
- 跟踪事件
- TTY
- UDP/数据报
- URL
- 实用程序
- V8
- 虚拟机
- WebAssembly
- Web加密 API(Web Crypto API)
- 网络流 API(Web Streams API)
- 工作线程(Worker threads)
- zlib
Node.js v18.18.2 文档
- Node.js v18.18.2
- ► 目录
-
►
索引
- 断言测试
- 异步上下文跟踪
- 异步钩子
- 缓冲(Buffer)
- C++ 插件
- 使用 Node-API 的 C/C++ 插件
- C++ 嵌入 Node环境
- 子进程(Child processes)
- 集群(Cluster)
- 命令行选项
- 控制台(Console)
- 核心包(Corepack)
- 加密(Crypto)
- 调试器(Debugger)
- 已弃用的 API
- 诊断通道(Diagnostics Channel)
- 域名系统(DNS)
- 域(Domain)
- 错误(Errors)
- 事件(Events)
- 文件系统(File system)
- 全局变量(Globals)
- HTTP
- HTTP/2
- HTTPS
- 检查器(Inspector)
- 国际化
- 模块：CommonJS 模块
- 模块：ECMAScript 模块
- 模块：
node:moduleAPI - 模块：packages 模块
- 网络(Net)
- 系统(OS)
- 路径(Path)
- 性能挂钩(Performance hooks)
- 性能挂钩(Permissions)
- 进程(Process)
- Punycode 国际化域名编码
- 查询字符串(Query strings)
- 命令行库(Readline)
- REPL 交互式编程环境
- 诊断报告
- 单个可执行应用程序
- Stream 流
- 字符串解码器
- 单元测试
- 定时器(Timers)
- 传输层安全/SSL
- 跟踪事件
- TTY
- UDP/数据报
- URL
- 实用程序
- V8
- 虚拟机
- WebAssembly
- Web加密 API(Web Crypto API)
- 网络流 API(Web Streams API)
- 工作线程(Worker threads)
- zlib
- ► 其他版本
- ► 选项
关于本文档#
欢迎来到 Node.js 官方 API 参考文档！
Node.js 是一个基于V8 JavaScript 引擎构建的 JavaScript 运行时。
贡献#
稳定性指标#
整个文档都表明了某个部分的稳定性。有些 API 已经被证明如此并且如此值得依赖，以至于它们根本不可能改变。其他是全新的和实验性的，或者已知是危险的。
稳定性指标如下：
稳定性：0 - 已弃用。该功能可能会发出警告。不保证向后兼容性。
稳定性：1 - 实验性。该功能不受
语义版本控制规则的约束。在任何未来版本中可能会发生非向后兼容的更改或删除。不建议在生产环境中使用该功能。
稳定性：2-稳定。与 npm 生态系统的兼容性是重中之重。
稳定性：3 - 传统。尽管此功能不太可能被删除，并且仍然受到语义版本控制保证的保护，但它不再被积极维护，并且可以使用其他替代方案。
如果使用不会造成任何损害，则功能会被标记为遗留功能，而不是被弃用，并且它们在 npm 生态系统中得到广泛依赖。遗留功能中发现的错误不太可能得到修复。
使用实验功能时要小心，尤其是在模块内。用户可能不知道正在使用实验性功能。当实验性 API 修改发生时，错误或行为变化可能会让用户感到惊讶。为了避免意外，使用实验功能可能需要命令行标志。实验性功能也可能会发出警告。
Stability overview#
| API | Stability |
|---|---|
| Assert | (2) Stable |
| Async hooks | (1) Experimental |
| Asynchronous context tracking | (2) Stable |
| Buffer | (2) Stable |
| Child process | (2) Stable |
| Cluster | (2) Stable |
| Console | (2) Stable |
| Crypto | (2) Stable |
| Diagnostics Channel | (2) Stable |
| DNS | (2) Stable |
| Domain | (0) Deprecated |
| File system | (2) Stable |
| HTTP | (2) Stable |
| HTTP/2 | (2) Stable |
| HTTPS | (2) Stable |
| Inspector | (2) Stable |
| Modules: CommonJS modules | (2) Stable |
| OS | (2) Stable |
| Path | (2) Stable |
| Performance measurement APIs | (2) Stable |
| Punycode | (0) Deprecated |
| Query string | (2) Stable |
| Readline | (2) Stable |
| REPL 交互式编程环境 | (2) Stable |
| Single executable applications | (1) Experimental: This feature is being designed and will change. |
| Stream | (2) Stable |
| String decoder | (2) Stable |
| Test runner | (1) Experimental |
| Timers | (2) Stable |
| TLS (SSL) | (2) Stable |
| Trace events | (1) Experimental |
| TTY | (2) Stable |
| UDP/datagram sockets | (2) Stable |
| URL | (2) Stable |
| Util | (2) Stable |
| VM (executing JavaScript) | (2) Stable |
| Web Crypto API | (1) Experimental |
| Web Streams API | (1) Experimental. |
| WebAssembly System Interface (WASI) | (1) Experimental |
| Worker threads | (2) Stable |
| Zlib | (2) Stable |
JSON 输出#
每个.html文档都有一个对应的.json文档。这适用于 IDE 和使用文档的其他实用程序。
系统调用和手册页#
包装系统调用的 Node.js 函数将记录这一点。该文档链接到相应的手册页，其中描述了系统调用的工作原理。
大多数 Unix 系统调用都有 Windows 类似的系统调用。尽管如此，行为差异可能是不可避免的。