当前文档翻译自 Node.js 6.x 官方文档,致力于从概念和实践两方面介绍 Node.js API。文档整体分为多个章节,每一章节针对一个模块或一个高阶概念展开。
稳定性
在阅读文档的过程中,你会经常看到如下四种稳定性标识,用于标识当前 API 的稳定程度:
当前模块存在已知问题,不建议继续使用该模块;继续使用该模块时,Node.js 系统会抛出警告信息,无法有效保障兼容性。
当前模块正在开发中,需要使用命令行参数启动,未来可能会被修改或移除。
当前模块整体表现稳定,除非绝对需要,否则不会修改;以 NPM 开发环境的兼容性为优先开发原则。
当前模块的功能已锁定,不接受新的 API 建议,后续只会进行安全、性能或 Bug 方面的维护工作。
本文档不会翻译稳定性为 0 的模块,也不建议开发者使用此类模块。
系统调用和 man 页面
类似 open(2) 和 read(2) 的系统调用命令直接存在于用户程序与底层操作系统之间。对于 Node.js 简单封装的系统调用命令都会在文档中显式标注,比如 fs.open()
。对于系统调用命令,文档会直接链接到相应的 man 页面。
警告: 部分系统调用命令是某些系统特有的,比如 lchown(2) 就是 BSD Unix 特有的。也就是说,fs.lchown()
只能用于 Mac OS X 和其他 BSD 衍生操作系统,不能用于 Linux 和 Windows 系统。
大多数的 Unix 系统调用命令在 Windows 上都有类似的系统调用命令,但两者的行为可能不同,在某些时候两者微妙的差异导致了绝对的不可替代性,详细信息请参考 Node issue 4760。