关于本文档 | Node.js v24.0.0 文档

关于本文档#

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

Node.js 是一个构建在 V8 JavaScript 引擎之上的 JavaScript 运行时。

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

在整个文档中，都标明了各部分的稳定性。有些 API 经过了验证，并受到高度依赖，因此几乎不会发生任何变化。其他的则是全新的实验性的，或者已知是危险的。

稳定性指标如下

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

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

实验性功能分为几个阶段

1.0 - 早期开发。此阶段的实验性功能尚未完成，可能会发生重大更改。
1.1 - 积极开发。此阶段的实验性功能正接近最低可行性。
1.2 - 发布候选。此阶段的实验性功能有望变得稳定。预计不会再发生重大更改，但仍可能因用户反馈而发生。我们鼓励用户进行测试和反馈，以便我们知道此功能已准备好标记为稳定。

实验性功能通常通过升级为稳定版或在没有弃用周期的情况下删除来退出实验状态。

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

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

如果某个功能的使用没有危害，并且在 npm 生态系统中被广泛使用，则将其标记为遗留功能而不是已弃用功能。遗留功能中发现的错误不太可能得到修复。

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

新增于：v0.6.12

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

包装系统调用的 Node.js 函数将记录该调用。这些文档链接到相应的手册页，这些手册页描述了系统调用的工作方式。

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