Node.js v16.20.2 文档


关于本文档#>

【About this documentation】

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

【Welcome to the official API reference documentation for Node.js!】

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

【Node.js is a JavaScript runtime built on the V8 JavaScript engine.】

贡献#>

【Contributing】

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

【Report errors in this documentation in the issue tracker. See the contributing guide for directions on how to submit pull requests.】

稳定性指标#>

【Stability index】

在整个文档中都有关于各部分稳定性的说明。有些 API 已经经过充分验证并被广泛依赖,几乎不可能再发生任何改变。另一些则是全新且实验性的,或者已知存在风险。

【Throughout the documentation are indications of a section's stability. Some APIs are so proven and so relied upon that they are unlikely to ever change at all. Others are brand new and experimental, or known to be hazardous.】

稳定性指数如下:

【The stability indices are as follows:】

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

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

稳定性: 2 - 稳定。与 npm 生态系统的兼容性是优先考虑的事项。

稳定性: 3 - 传统。尽管该功能不太可能被移除,并且仍然受到语义版本保证的覆盖,但它不再被积极维护,而且已有其他可选方案。

如果某些功能的使用没有造成伤害,并且在 npm 生态系统中被广泛依赖,它们会被标记为遗留功能,而不是被弃用。在遗留功能中发现的错误不太可能被修复。

【Features are marked as legacy rather than being deprecated if their use does no harm, and they are widely relied upon within the npm ecosystem. Bugs found in legacy features are unlikely to be fixed.】

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

【Use caution when making use of Experimental features, particularly within modules. Users may not be aware that experimental features are being used. Bugs or behavior changes may surprise users when Experimental API modifications occur. To avoid surprises, use of an Experimental feature may need a command-line flag. Experimental features may also emit a warning.】

稳定性概述#>

【Stability overview】

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(1) 实验
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(3) 旧版
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 输出#>

【JSON output】

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

【Every .html document has a corresponding .json document. This is for IDEs and other utilities that consume the documentation.】

系统调用和手册页面#>

【System calls and man pages】

封装系统调用的 Node.js 函数会在文档中说明这一点。文档会链接到相应的手册页,描述系统调用的工作原理。

【Node.js functions which wrap a system call will document that. The docs link to the corresponding man pages which describe how the system call works.】

大多数 Unix 系统调用在 Windows 中有类似功能。不过,行为差异仍可能无法避免。

【Most Unix system calls have Windows analogues. Still, behavior differences may be unavoidable.】

Node.js 中文网 - 粤ICP备13048890号