本文档的目的,是全面地解释Node.js的API,便可做为参考文档,同时也包含了概念的讲解。每一个章节都描述了一个内置模块或一个高阶概念(high-level concept)。html
属性类型、函数参数、事件句柄的传参等,都在相应主题的标题下方详细列出。linux
贯穿整个文档,你会看到不少“稳定性标签”标注了章节所描述内容的稳定性。Node.js API还处于不断成熟的阶段,有的模块可靠性会高于其余模块。有的通过实践证实,而且被普遍使用的特性会不多变动。但有的全新的、实验性的,或者存在危险性的部分则会被从新设计。git
全部的“稳定性标签”以下所示:github
稳定级别: 0 - 已废弃npm
本特性存在问题并将会被修改。请不要使用。使用此特性可能会致使错误告警。不会存在后向兼容。安全
稳定级别: 1 - 实验性函数
本特性将会被修改,使用时会在命令行出现提示。在将来版本中可能会被修改或废弃。性能
稳定级别: 2 - 稳定操作系统
此API已被证实符合预期。除非绝对必要的话,将会持续兼容
npm
生态。命令行
稳定级别: 3 - 锁定
只会有安全、性能或bug相关的修复。不接受对此API作修改的建议。
系统调用,好比open和read,定义了用户程序和底层操做系统的交互方式。有的Node函数就是对系统调用的简单封装,如fs.open()
,会有一个连接指向相应的man
页面(是manual pages的缩写),详细描述此系统调用的原理。
附注:有的系统调用,如lchown,是BSD专用的。好比fs.lchown()
,意味着他们只能在Mac OS X和其余基于BSD的系统里才有效。
大部分Unix系统调用都在Windows上有等价,但实现可能有不一样。
请查看:全文目录