本文檔翻譯自 Node.js 官方文檔,適用于 V0.12.2。
本文檔從引用參考和概念兩個方面全面的解釋了 Node.js API。每個章節描述了一個模塊或高級概念。
一般情況下,屬性、方法參數,及事件都會列在主標題下的列表中。
每個 .html
文檔都有對應的 .json
,它們包含相同的結構化內容。這些東西目前還是實驗性的,主要為各種集成開發環境(IDE)和開發工具提供便利。
每個 .html
和 .json
文件都和 doc/api/
目錄下的 .markdown
文件相對應。這些文檔使用 tools/doc/generate.js
程序生成。 HTML 模板位于 doc/template.html
。
在文檔中,你會看到每個章節的穩定性標志。Node.js API 還在改進中,成熟的部分會比其他章節值得信賴。經過大量驗證和依賴的 API 是一般是不會變的。其他新增的,試驗性的,或被證明具有危險性的部分正重新設計。
穩定性標志包括以下內容:
穩定性(Stability): 0 - 拋棄
這部分內容有問題,并已計劃改變。不要使用這些內容,可能會引起警告。不要想什么向后兼容性了。
穩定性(Stability): 1 - 試驗
這部分內容最近剛引進,將來的版本可能會改變也可能會被移除。你可以試試并提供反饋。如果你用到的部分對你來說非常重要,可以告訴 node 的核心團隊。
穩定性(Stability): 2 - 不穩定
這部分 API 正在調整中,還沒在實際工作測試中達到滿意的程度。如果合理的話會保證向后兼容性。
穩定性(Stability): 3 - 穩定
這部分 API 驗證過基本能令人滿意,但是清理底層代碼時可能會引起小的改變。保證向后的兼容性。
穩定性(Stability): 4 - API 凍結
這部分的 API 已經在產品中廣泛試驗,不太可能被改變。
穩定性(Stability): 5 - 鎖定
除非發現了嚴重 bug,否則這部分代碼永遠不會改變。請不要對這部分內容提出更改建議,否則會被拒絕。
穩定性(Stability): 1 - 試驗
每個通過 markdown 生成的 HTML 文件都有相應的 JSON 文件。
這個特性從 v0.6.12 開始,是試驗性功能。
更新日期 | 更新內容 |
---|---|
2015-04-21 | 第一版發布,翻譯自 Node.js V0.12.2 官方文檔 |