Node.js v11.14.0 文档


关于本文档#

中英对照提交修改

本文档的目的是从参考和概念的角度全面解释 Node.js 的 API。 每个部分都描述了内置模块或高级概念。

在适当的情况下,属性类型、方法参数、以及提供给事件处理函数的参数将在主题标题下方的列表中详细说明。

参与贡献#

中英对照提交修改

如果在本文档中发现错误,请提交问题或参阅有关如何提交补丁的说明的参考指南

稳定性指数#

中英对照提交修改

在整个文档中都有关于章节稳定性的指示。 Node.js 的 API 仍在不断变化,随着发展成熟,某些部分比其他部分更可靠。 有些是已经被证明、被依赖,它们根本不可能再改变。 有些是全新的和试验性的、或者已知是危险的并且在重新设计的过程中。

稳定性指数如下:

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

稳定性: 1 - 试验。 此特性仍在积极开发中,并且在将来的任何版本中都会受到非向后兼容的更改或删除。 建议不要在生产环境中使用该特性。 试验的特性不受 Node.js 语义版本控制模型的约束。

稳定性: 2 - 稳定。 与 npm 生态系统的兼容性是最高优先级。

在使用试验的特性时必须谨慎,特别是在可能用作 Node.js 应用程序中的依赖项(或依赖项的依赖项)的模块中。 终端用户可能不知道正在使用试验的特性,因此在 API 修改发生时可能会遇到意外故障或行为更改。 为了避免此类意外,试验的特性可能需要命令行标志才能显式启用它们,或者可能导致发出进程警告。 默认情况下,此类警告会打印到 stderr,并且可以通过将监听器附加到 'warning' 事件来处理。

JSON 输出#

暂无中英对照

稳定性: 1 - 试验

Every .html document has a corresponding .json document presenting the same information in a structured manner. This feature is experimental, and added for the benefit of IDEs and other utilities that wish to do programmatic things with the documentation.

系统调用与帮助文档#

中英对照提交修改

open(2)read(2) 这样的系统调用定义了用户程序和底层操作系统之间的接口。 Node.js 函数简单地封装了系统调用,例如 fs.open()。 相应的帮助文档描述了系统调用的工作方式。

大多数 Unix 系统调用都有 Windows 等价物,但 Windows 相对于 Linux 和 macOS 的行为可能不同。 有关在 Windows 上有时无法替换 Unix 系统调用语义的微妙方法的示例,请参阅 Node.js 的讨论贴