關於此文件#

歡迎使用 Node.js 官方 API 參考文件！

Node.js 是建立在 V8 JavaScript 引擎 上的 JavaScript 執行環境。

貢獻#

在 問題追蹤器 中回報此文件中的錯誤。請參閱 貢獻指南 以取得如何提交拉取請求的說明。

穩定性指標#

文件中的各個章節會標示其穩定性。有些 API 已經過驗證且廣受依賴，不太可能在任何時候發生變更。其他 API 則很新且仍處於實驗階段，或已知有風險。

穩定性指標如下

穩定性：0 - 已棄用。此功能可能會發出警告。不保證向後相容性。

穩定性：1 - 實驗性。此功能不受 語意化版本控制 規則約束。在任何未來版本中都可能發生不向後相容的變更或移除。不建議在生產環境中使用此功能。

實驗性功能細分為以下階段

  • 1.0 - 早期開發。此階段的實驗性功能尚未完成，且可能會大幅變更。
  • 1.1 - 積極開發。此階段的實驗性功能已接近最低可行性。
  • 1.2 - 發行候選。此階段的實驗性功能有望成為穩定版本。預期不會再有重大變更，但仍可能根據使用者回饋進行變更。我們鼓勵使用者進行測試並提供回饋，讓我們知道此功能是否已準備好標示為穩定版本。

穩定性：2 - 穩定。與 npm 生態系相容性為優先要務。

穩定性：3 - 舊版。雖然此功能不太可能會移除，且仍受語意版本保證涵蓋，但已不再積極維護，且有其他替代方案可用。

如果功能的使用並無害，且在 npm 生態系中廣泛依賴，則會標示為舊版，而非已棄用。舊版功能中發現的錯誤不太可能修復。

使用實驗性功能時請小心，特別是在撰寫函式庫時。使用者可能不知道正在使用實驗性功能。當實驗性 API 修改時，錯誤或行為變更可能會讓使用者感到意外。為避免意外，使用實驗性功能可能需要使用命令列旗標。實驗性功能也可能會發出 警告。

穩定性概觀#

API穩定性
斷言(2) 穩定
非同步掛鉤(1) 實驗性
非同步內容追蹤(2) 穩定
緩衝區(2) 穩定
子程序(2) 穩定
叢集(2) 穩定
主控台(2) 穩定
加密(2) 穩定
診斷頻道(2) 穩定
DNS(2) 穩定
網域(0) 已棄用
檔案系統(2) 穩定
HTTP(2) 穩定
HTTP/2(2) 穩定
HTTPS(2) 穩定
檢查器(2) 穩定
模組：node:module API(1) .2 - 發行候選
模組：CommonJS 模組(2) 穩定
作業系統(2) 穩定
路徑(2) 穩定
效能測量 API(2) 穩定
Punycode(0) 已棄用
查詢字串(2) 穩定
Readline(2) 穩定
REPL(2) 穩定
單一可執行應用程式(1) .1 - 積極開發
串流(2) 穩定
字串解碼器(2) 穩定
測試執行器(2) 穩定
計時器(2) 穩定
TLS (SSL)(2) 穩定
追蹤事件(1) 實驗性
TTY(2) 穩定
UDP/資料報套接字(2) 穩定
URL(2) 穩定
Util(2) 穩定
VM (執行 JavaScript)(2) 穩定
Web Crypto API(2) 穩定
Web Streams API(2) 穩定
WebAssembly 系統介面 (WASI)(1) 實驗性
工作執行緒(2) 穩定
Zlib(2) 穩定

JSON 輸出#

新增於：v0.6.12

每個 .html 文件都有對應的 .json 文件。這是針對使用說明文件的 IDE 和其他工具。

系統呼叫和手冊頁#

包裝系統呼叫的 Node.js 函式會記錄該呼叫。文件會連結到對應的手冊頁，說明系統呼叫如何運作。

大多數 Unix 系統呼叫都有 Windows 類比。不過，行為差異可能是無法避免的。