【譯文】Node.js官方文檔（Part 1 關(guān)于文檔）

svtter 發(fā)布于2019-08-21 11:19 / 919人閱讀

摘要：關(guān)于本文檔本文檔的目的，是全面地解釋的，即可作為參考文檔，同時也包含了概念的講解。但有的全新的實驗性的，或者存在危險性的部分則會被重新設(shè)計。穩(wěn)定級別鎖定只會有安全性能或相關(guān)的修復(fù)。不接受對此做修改的建議。

關(guān)于本文檔

本文檔的目的，是全面地解釋Node.js的API，即可作為參考文檔，同時也包含了概念的講解。每個章節(jié)都描述了一個內(nèi)置模塊或一個高階概念（high-level concept）。

屬性類型、函數(shù)參數(shù)、事件句柄的傳參等，都在相應(yīng)主題的標(biāo)題下方詳細(xì)列出。

穩(wěn)定性標(biāo)簽

貫穿整個文檔，你會看到很多“穩(wěn)定性標(biāo)簽”標(biāo)注了章節(jié)所描述內(nèi)容的穩(wěn)定性。Node.js API還處于不斷成熟的階段，有的模塊可靠性會高于其他模塊。有的經(jīng)過實踐證明，并且被廣泛使用的特性會很少變更。但有的全新的、實驗性的，或者存在危險性的部分則會被重新設(shè)計。

所有的“穩(wěn)定性標(biāo)簽”如下所示：

穩(wěn)定級別: 0 - 已廢棄

本特性存在問題并將會被修改。請不要使用。使用此特性可能會導(dǎo)致錯誤告警。不會存在后向兼容。

穩(wěn)定級別: 1 - 實驗性
本特性將會被修改，使用時會在命令行出現(xiàn)提示。在未來版本中可能會被修改或廢棄。

穩(wěn)定級別: 2 - 穩(wěn)定
此API已被證明符合預(yù)期。除非絕對必要的話，將會持續(xù)兼容npm生態(tài)。

穩(wěn)定級別: 3 - 鎖定
只會有安全、性能或bug相關(guān)的修復(fù)。不接受對此API做修改的建議。

系統(tǒng)調(diào)用&MAN頁面

系統(tǒng)調(diào)用，比如open和read，定義了用戶程序和底層操作系統(tǒng)的交互方式。有的Node函數(shù)就是對系統(tǒng)調(diào)用的簡單封裝，如fs.open()，會有一個鏈接指向相應(yīng)的man頁面（是manual pages的縮寫），詳細(xì)描述此系統(tǒng)調(diào)用的原理。

附注：有的系統(tǒng)調(diào)用，如lchown，是BSD專用的。比如fs.lchown()，意味著他們只能在Mac OS X和其他基于BSD的系統(tǒng)里才有效。

大部分Unix系統(tǒng)調(diào)用都在Windows上有等價，但實現(xiàn)可能有不同。

全文目錄

請查看：全文目錄