【译文】Node.js官方文档(Part 1 关于文档)

关于本文档

本文档的目标,是周全地诠释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上有等价,但完成能够有差别。

全文目次

请检察:全文目次

    原文作者:uglybachelor
    原文地址: https://segmentfault.com/a/1190000007851945
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞