Node.js API參考文檔（關於文檔）

關於文檔

本文檔的目的是從參考和概念的角度全面解釋Node.js API，每一個部分都描述了內置模塊或高級概念。

在適當的狀況下，屬性類型、方法參數和提供給事件處理程序的參數將在主題標題下方的列表中詳細說明。

貢獻

若是在本文檔中發現錯誤，請提交問題或參閱有關如何提交補丁的說明的貢獻指南。

每一個文件都是根據Node.js源代碼樹中doc/api/文件夾中相應的.md文件生成的，使用tools/ doc/generate.js程序生成文檔，HTML模板位於doc/template.html。

穩定性指數

在整個文檔中都有關於章節穩定性的指數，Node.js API仍在不斷變化，隨着它的成熟，某些部分比其餘部分更可靠，有些是如此被證實，如此依賴，他們根本不可能改變，其餘是全新的和實驗性的，或者已知是危險的而且在從新設計的過程當中。

穩定性指數以下：

穩定性：0 - 棄用，該功能可能會發出警告，不保證向後兼容性。

穩定性：1 - 實驗，此功能仍在積極開發中，而且在未來的任何版本中都會受到非向後兼容的更改或刪除，建議不要在生產環境中使用該功能，實驗功能不受Node.js語義版本控制模型的約束。

穩定性：2 - 穩定，與npm生態系統的兼容性是一個高優先級。

在使用Experimental特性時必須謹慎，特別是在可能用做Node.js應用程序中的依賴項（或依賴項的依賴項）的模塊中。最終用戶可能不知道正在使用實驗性功能，所以在API修改發生時可能會遇到意外故障或行爲更改，爲了不此類意外，Experimental功能可能須要命令行標誌才能顯式啓用它們，或者可能致使發出進程警告。默認狀況下，此類警告會打印到stderr，而且能夠經過將偵聽器附加到'warning'事件來處理。

JSON輸出

添加於：v0.6.12

穩定性：1 - 實驗

每一個.html文檔都有一個相應的.json文檔，以結構化的方式呈現相同的信息，此功能是實驗性的，而且爲了IDE和其餘但願使用文檔執行編程工做的實用程序的效益而添加。

系統調用和手冊頁

像open(2)和read(2)這樣的系統調用定義了用戶程序和底層操做系統之間的接口，簡單地包裝系統調用的Node.js函數，如fs.open()，將記錄它。文檔連接到相應的手冊頁（手冊頁的簡稱），描述了系統調用的工做方式。

大多數Unix系統調用都有Windows等價的，但Windows相對於Linux和macOS的行爲可能不一樣，有關在Windows上有時沒法替換Unix系統調用語義的微妙方法的示例，請參閱Node.js issue 4760。

---

上一篇：Node.js API參考文檔（目錄）

下一篇：用法和示例