关于此文档

关于此文档

该文档将从同时使用和概念两个方面详细的介绍 Node.js 的API，每一个章节都将描述了一个内建模块或高级概念。

引用，数据类型，方法的参数以及事件提供的参数都将被详细的列举在标题的下方。

每一个.html文件都有一个与之对应的.json文件，用结构化的方式表述相同的内容。这个功能是实验性的，用以增强对IDE的支持以及其他与文档相关的事务。

每一个.html与.json文件都基于node资源树中doc/api/文件夹内相对应的.macrkdown文件。该文档使用tools/doc/generate.js程序生成的，其HTML模板为 doc/temlplate.html文件。

 

稳定性标识

在整篇文档中，我们将看到章节的稳定性标识。Node.js的API是在不断变化的，随着它的成熟，其中一些部分必然比其他部分更加稳定。那些被证明可信赖的部分将不会被改变，而一些新的实验性的分支，或者有害的部分将被重新设计。

以下是稳定性标识：

稳定性 0 弃用的
这项功能被证明是有问题的，并且正在被计划修改。请不要依赖于它。使用这个功能将会导致一些警告以及一些不可预知的兼容性问题。

稳定性 1 实验性的
这样功能是最近被引进，有可能在将来的版本中被更改或移除。请试着使用它并提交反馈。如果他解决了一个对你来说非常重要的用例，请告知node核心小组。

稳定性 2 不稳定的
这个API正在稳定的过程中，但是还没有经过足够的测试证明其足够稳定。如果合理的话，向后的兼容性将被保留。

稳定性 3 稳定的
这个API被充分的证明，但在清理底层代码时将导致一些细微的变化。向后的兼容性将被保证。

稳定性 4 API冻结
这个API在产品中经过了大量的测试，并不再准备改变。

稳定性 5 锁定的
除非发现了非常严重得缺陷，否则这段代码将不再被更改。请不要建议更改这个部分，这些建议将被拒绝。

JSON输出

稳定性 1 实验性的

在markdown中，每一个HTML文件都有一个与之对应的，拥有相同数据的json文件。

这个功能始于v0.6.12版本，是一个实验性的功能。