Node.js API参考文档（关于文档）

关于文档

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

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

贡献

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

每个文件都是根据Node.js源代码树中doc/api/文件夹中相应的.md文件生成的，使用tools/ doc/generate.js程序生成文档，HTML模板位于doc/template.html。

稳定性指数

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

稳定性指数如下：

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

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

稳定性：2 - 稳定，与npm生态系统的兼容性是一个高优先级。

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

JSON输出

添加于：v0.6.12

稳定性：1 - 实验

每个.html文档都有一个相应的.json文档，以结构化的方式呈现相同的信息，此功能是实验性的，并且为了IDE和其他希望使用文档执行编程工作的实用程序的效益而添加。

系统调用和手册页

像open(2)和read(2)这样的系统调用定义了用户程序和底层操作系统之间的接口，简单地包装系统调用的Node.js函数，如fs.open()，将记录它。文档链接到相应的手册页（手册页的简称），描述了系统调用的工作方式。

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

---

上一篇：Node.js API参考文档（目录）

下一篇：用法和示例