關於文件
本文件的目的是從參考和概念的角度全面解釋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。