Node.js v8.1.2 文档


关于本文档#

查看英文版 / 参与翻译

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

需要时,属性类型、方法参数、以及提供给事件处理函数的参数都会在主题标题下的列表中详细说明。

稳定性指数#

查看英文版 / 参与翻译

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

稳定性指数如下:

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

JSON 输出#

查看英文版 / 参与翻译

稳定性: 1 - 试验的

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

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

系统调用与帮助文档#

查看英文版 / 参与翻译

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

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

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