关于本文档

本文档的目的,是全面地解释Node.js的API,即可作为参考文档,同时也包含了概念的讲解。每个章节都描述了一个内置模块或一个高阶概念(high-level concept)。

属性类型、函数参数、事件句柄的传参等,都在相应主题的标题下方详细列出。

稳定性标签

贯穿整个文档,你会看到很多“稳定性标签”标注了章节所描述内容的稳定性。Node.js API还处于不断成熟的阶段,有的模块可靠性会高于其他模块。有的经过实践证明,并且被广泛使用的特性会很少变更。但有的全新的、实验性的,或者存在危险性的部分则会被重新设计。

所有的“稳定性标签”如下所示:

稳定级别: 0 - 已废弃

本特性存在问题并将会被修改。请不要使用。使用此特性可能会导致错误告警。不会存在后向兼容。

稳定级别: 1 - 实验性

本特性将会被修改,使用时会在命令行出现提示。在未来版本中可能会被修改或废弃。

稳定级别: 2 - 稳定

API已被证明符合预期。除非绝对必要的话,将会持续兼容npm生态。

稳定级别: 3 - 锁定

只会有安全、性能或bug相关的修复。不接受对此API做修改的建议。

系统调用&MAN页面

系统调用,比如openread,定义了用户程序和底层操作系统的交互方式。有的Node函数就是对系统调用的简单封装,如fs.open(),会有一个链接指向相应的man页面(是manual pages的缩写),详细描述此系统调用的原理。

附注:有的系统调用,如lchown,是BSD专用的。比如fs.lchown(),意味着他们只能在Mac OS X和其他基于BSD的系统里才有效。

大部分Unix系统调用都在Windows上有等价,但实现可能有不同。


全文目录

请查看:全文目录

本文固定链接: http://www.js-code.com/node-js/node-js_36846.html