Node.js v18.16.0 文档

目录

关于本文档#

欢迎使用 Node.js 的官方 API 参考文档！

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

贡献#

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

稳定性指标#

在文档中都有章节稳定性的标志。 有些 API 已被证明和依赖，因此它们几乎不可能改变。 有些则是全新的和实验的、或者已知是危险的。

稳定性指数如下：

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

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

稳定性: 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) 稳定
single-executable-applications(1) 实验
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 输出#

新增于: v0.6.12

每个 .html 文档都有对应的 .json 文档。 这适用于使用该文档的 IDE 和其他实用工具。

系统调用和手册页面#

封装系统调用的 Node.js 函数会在文档中描述。 文档链接到对应的描述该系统调用的工作方式的帮助手册。

大多数 Unix 系统调用都有 Windows 类似物。 尽管如此，行为的差异可能是不可避免的。