本文檔的目的,是全面地解釋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上有等價,但實現可能有不一樣。
請查看:全文目錄