關(guān)于 Node.js

2022-02-26 10:27 更新

本文檔翻譯自 Node.js 官方文檔,適用于 V0.12.2。

本文檔將從引用參考和概念兩個方面來對Node.js API進(jìn)行全面的解釋,讓你更加了解Node.js API。

Node.js官方文檔的每個章節(jié)描述了一個內(nèi)置模塊或高級概念。

一般情況下,屬性、方法參數(shù),以及提供給事件處理程序的參數(shù)都會在主標(biāo)題下的列表中詳細(xì)說明。

每個.html文檔都有對應(yīng)的.json,它們包含相同的結(jié)構(gòu)化內(nèi)容。這些東西目前還是實(shí)驗(yàn)性的,主要為各種集成開發(fā)環(huán)境(IDE)和開發(fā)工具提供便利。

每個.html.json文件都和doc/api/目錄下的.markdown文件相對應(yīng)。這些文檔使用tools/doc/generate.js程序生成。 HTML模板位于doc/template.html。

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

在文檔中,你會看到每個章節(jié)的穩(wěn)定性標(biāo)志。Node.js API還在改進(jìn)中,成熟的部分會比其他章節(jié)值得信賴。經(jīng)過大量驗(yàn)證和依賴的API是一般是不會變的。其他新增的,試驗(yàn)性的,或被證明具有危險(xiǎn)性的部分正被重新設(shè)計(jì)。

穩(wěn)定性標(biāo)志包括以下內(nèi)容:

穩(wěn)定性(Stability): 0 - 拋棄
這部分內(nèi)容有問題,并已計(jì)劃改變。不要使用這些內(nèi)容,可能會引起警告。不要想什么向后兼容性了。
穩(wěn)定性(Stability): 1 - 試驗(yàn)
這部分內(nèi)容最近剛引進(jìn),將來的版本可能會改變也可能會被移除。你可以試試并提供反饋。如果你用到的部分對你來說非常重要,可以告訴 node 的核心團(tuán)隊(duì)。
穩(wěn)定性(Stability): 2 - 不穩(wěn)定
這部分 API 正在調(diào)整中,還沒在實(shí)際工作測試中達(dá)到滿意的程度。如果合理的話會保證向后兼容性。
穩(wěn)定性(Stability): 3 - 穩(wěn)定
這部分 API 驗(yàn)證過基本能令人滿意,但是清理底層代碼時可能會引起小的改變。保證向后的兼容性。
穩(wěn)定性(Stability): 4 - API 凍結(jié)
這部分的 API 已經(jīng)在產(chǎn)品中廣泛試驗(yàn),不太可能被改變。
穩(wěn)定性(Stability): 5 - 鎖定
除非發(fā)現(xiàn)了嚴(yán)重 bug,否則這部分代碼永遠(yuǎn)不會改變。請不要對這部分內(nèi)容提出更改建議,否則會被拒絕。

JSON 輸出

穩(wěn)定性(Stability): 1 - 試驗(yàn)

每個通過 markdown 生成的 HTML 文件都有相應(yīng)的 JSON 文件。

這個特性從 v0.6.12 開始,是試驗(yàn)性功能。

更新日期更新內(nèi)容
2015-04-21第一版發(fā)布,翻譯自 Node.js V0.12.2 官方文檔

相關(guān)教程

JSON教程


以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號