Skip to content

关于本文档

欢迎来到 Node.js 官方 API 参考文档!

Node.js 是一个基于 V8 JavaScript 引擎 构建的 JavaScript 运行时环境。

贡献

请在 问题追踪器 中报告本文档中的错误。有关如何提交拉取请求的说明,请参阅 贡献指南

稳定性索引

文档中随处可见关于某一部分稳定性的指示。某些 API 经过充分验证且依赖性很高,因此不太可能发生任何更改。其他一些 API 则全新且处于实验阶段,或已知存在风险。

稳定性索引如下所示:

[稳定性: 0 - 已弃用]

稳定性: 0 稳定性: 0 - 已弃用。此功能可能会发出警告。不保证向后兼容性。

[稳定性: 1 - 实验性]

稳定性: 1 稳定性: 1 - 实验性。此功能不受 语义版本控制 规则约束。在任何将来的版本中都可能发生不向后兼容的更改或删除。不建议在生产环境中使用此功能。

[稳定性: 2 - 稳定]

稳定性: 2 稳定性: 2 - 稳定。与 npm 生态系统的兼容性是重中之重。

[稳定性: 3 - 遗留]

稳定性: 3 稳定性: 3 - 遗留。虽然此功能不太可能被删除,并且仍然受语义版本控制保证的约束,但它不再积极维护,并且可以使用其他替代方案。

如果功能的使用不会造成任何损害,并且在 npm 生态系统中得到广泛依赖,则将其标记为遗留功能,而不是已弃用功能。遗留功能中发现的错误不太可能得到修复。

使用实验性功能时请谨慎,尤其是在编写库时。用户可能不知道正在使用实验性功能。当实验性 API 修改发生时,错误或行为更改可能会让用户感到意外。为避免意外,使用实验性功能可能需要命令行标志。实验性功能也可能会发出 警告

稳定性概述

API稳定性
断言
(2) 稳定
异步钩子
(1) 实验性
异步上下文跟踪
(2) 稳定
缓冲区
(2) 稳定
子进程
(2) 稳定
集群
(2) 稳定
控制台
(2) 稳定
加密
(2) 稳定
诊断通道
(2) 稳定
DNS
(2) 稳定
(0) 已弃用
文件系统
(2) 稳定
HTTP
(2) 稳定
HTTP/2
(2) 稳定
HTTPS
(2) 稳定
检查器
(2) 稳定
模块: node:module API
(1) .2 - 发布候选版本 (异步版本) 稳定性: 1.1 - 主动开发 (同步版本)
模块: CommonJS 模块
(2) 稳定
模块: TypeScript
(1) .1 - 主动开发
操作系统
(2) 稳定
路径
(2) 稳定
性能测量 API
(2) 稳定
Punycode
(0) 已弃用
查询字符串
(2) 稳定
读取行
(2) 稳定
REPL
(2) 稳定
单执行文件应用程序
(1) .1 - 主动开发
SQLite
(1) .1 - 主动开发。
(2) 稳定
字符串解码器
(2) 稳定
测试运行器
(2) 稳定
计时器
(2) 稳定
TLS (SSL)
(2) 稳定
追踪事件
(1) 实验性
TTY
(2) 稳定
UDP/数据报套接字
(2) 稳定
URL
(2) 稳定
实用工具
(2) 稳定
VM (执行 JavaScript)
(2) 稳定
Web Crypto API
(2) 稳定
Web 流 API
(2) 稳定
WebAssembly 系统接口 (WASI)
(1) 实验性
工作线程
(2) 稳定
Zlib
(2) 稳定

JSON 输出

新增于:v0.6.12

每个 .html 文档都有一个对应的 .json 文档。这是为 IDE 和其他使用文档的工具准备的。

系统调用和手册页

封装系统调用的 Node.js 函数会对此进行说明。文档链接到相应的手册页,其中描述了系统调用的工作方式。

大多数 Unix 系统调用都有 Windows 等效项。尽管如此,行为差异可能是不可避免的。