Node.js 6.9.4 文档


关于本文档#

查看英文文档

本文档的目的是全面地讲解 Node.js 的 API,既从参考角度也从概念角度。 每个章节介绍一个内置模块或高级概念。

必要时,属性类型、方法参数、以及传给事件句柄的参数会在主题标题下的列表中详细说明。

每个 .html 文档都有一个对应的 .json 文档,以结构化的方式呈现相同的内容。 这个特性是试验的,用于帮助那些需要为编程提供文档的 IDE 或其他开发工具。

稳定性指数#

查看英文文档

贯穿整个文档,你会看到每个章节的稳定性标志。 Node.js 的 API 仍会有少量变化,但随着发展,部分 API 会更稳定可靠。 有些 API 历经考验、且被大量依赖,它们几乎不会再改变。 也有些 API 是新增的、或试验的、或被认定为有风险且正在重新设计中的。

稳定性的指标如下:

稳定性: 0 - 废弃的
这个特性被认定为存在问题,且正计划修改。
不要依赖该特性。
使用该特性可能会产生警告信息。
不要指望该特性会向后兼容。
稳定性: 1 - 试验的
这个特性可能会变化,在命令行中会有标记提示。
在将来的版本中该特性可能会变化或被移除。
稳定性: 2 - 稳定的
这个特性已被证明是符合要求的。
与 npm 生态系统的兼容性是一个高优先级,除非绝对必要否则不会变化。
稳定性: 3 - 锁定的
这个特性只接受与安全性、性能、或 BUG 修复有关的修改。
请不要在该特性提出修改 API 的建议,这些建议会被拒绝。

JSON 输出#

查看英文文档

稳定性: 1 - 试验的

每个通过 markdown 生成的 HTML 文件都有一个对应的具有相同数据的 JSON 文件。

这个特性是 Node.js v0.6.12 新增的。 该特性是试验的。

系统调用与帮助文档#

查看英文文档

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

警告:有些系统调用是 BSD 系统特有的,例如 lchown(2)。 这意味着 fs.chown() 只适用于 Mac OS X 和其他的 BSD 衍生系统,在 Linux 上不可用。

大部分 Unix 的系统调用都有对应的 Windows 版本,但 Windows 版本运行起来可能与 Linux 和 OS X 的有些差异。 有些 Unix 系统调用无法在 Windows 中找到对应的操作语义,详见议题4760