Node.js v12.16.1 文档


关于本文档#

中英对照提交修改

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

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

参与贡献#

中英对照提交修改

如果在本文档中发现错误,欢迎提交问题。 有关如何提交 pull request 的说明,请参阅贡献指南

稳定性指数#

中英对照提交修改

在整个文档中都有关于章节稳定性的指数。 有些 API 已经被验证、被依赖,且几乎不可能再改变。 有些则是全新的且试验性的、或者已知有危险的。

稳定性指数如下:

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

稳定性: 1 - 试验。 此特性不受语义化版本控制规范的约束。 在任何的未来版本中可能发生不向后兼容的更改或移除。 建议不要在生产环境中使用该特性。

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

在使用试验的特性时必须谨慎,特别是在模块中。 终端用户可能不知道正在使用试验的特性。 当试验的 API 发生修改时,可能会出现意外的故障或行为的改变。 为了避免此类意外,使用试验的特性可能需要命令行标志。 试验的特性也可能触发警告

JSON 输出#

中英对照提交修改

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

系统调用与帮助文档#

中英对照提交修改

封装了系统调用的 Node.js 函数将会在文档中描述。 相应的帮助文档会描述系统调用的工作方式。

大多数的 Unix 的系统调用都有 Windows 上的类似物。 但是,行为的差异可能是不可避免的。