关于本文档 - Node.js API 文档

来源：http://nodejs.cn/api/documentation/

关于本文档#

本文档的目标是，从参考和概念的角度全面地讲解 Node.js 的 API，每个章节描述了一个内置模块或高级概念。

属性的类型、方法的参数、以及事件处理的参数，都会被详细地列在标题下的列表中。

每一个.html文档都有一份对应的.json文档，且内容相同。 这个特性是实验性的，用于为一些需要文档辅助开发的 IDE 和其他工具提供帮助。

稳定度#

在文档中，您会看到关于每一个章节的稳定性的标示。 Node.js 的 API 仍会有少量的变化，当它不断完善时，部分模块会更加稳定可靠。 一些经过严格验证，且被大量依赖的 API 几乎不会再变化。 也有一些是新增的、实验性的、或重新设计中的。

稳定度定义如下：

稳定度： 0 - 已废弃此特性的 API 有问题，已有变更计划。不要依赖该 API，使用此特性可能会出现警告。不会考虑向后兼容性。

稳定度： 1 - 实验性此特性的 API 最近才引入，在未来的版本中可能会被变更或移除。欢迎试用并提供反馈。如果您有重要的用例使用此特性，请告知 Node 核心团队。

稳定度： 2 - 不稳定此特性的 API 正处于沉淀期，但还未经过充分的真实测试来验证以确保稳定。合理的 API 会保证向后兼容性。

稳定度： 3 - 稳定此特性的 API 已被证实是令人满意的，但对底层代码的梳理可能会造成微小的变动。保证向后兼容性。

稳定度： 4 - 已冻结此特性的 API 已经过生产环境的广泛测试，且不会有变动的必要。

稳定度： 5 - 已锁定此特性的 API 除非发现严重缺陷，否则代码不会被变更。请不要对该 API 提出变更建议，因为将被拒绝。

JSON 输出#

稳定度： 1 - 实验性

每个 HTML 文件都有一个对应的 JSON 文件，且它们数据一致。

该特性于 v0.6.12 版本引入。当前是实验性的。