关于本手册 | Node.js v21.7.2 文档

关于本手册#

欢迎使用 Node.js 的官方 API 参考手册！

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

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

整个文档中都标明了各个部分的稳定性。有些 API 经过充分验证，使用广泛，不太可能发生变化。而另一些则是全新的实验性 API，或已知存在风险。

稳定性指数如下所示：

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

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

实验性功能细分为以下阶段：

1.0 - 早期开发。此阶段的实验性功能尚未完善，可能会发生重大更改。
1.1 - 积极开发。此阶段的实验性功能即将达到最低可行性。
1.2 - 发布候选版本。此阶段的实验性功能有望成为稳定版本。预计不会再出现重大更改，但仍可能根据用户反馈进行更改。我们鼓励用户测试和反馈，以便我们能够确定该功能是否已准备好标记为稳定版本。

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

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

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

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

添加于：v0.6.12

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

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

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