關於此文檔

關於此文檔

該文檔將從同時使用和概念兩個方面詳細的介紹 Node.js 的API，每個章節都將描述了一個內建模塊或高級概念。

引用，數據類型，方法的參數以及事件提供的參數都將被詳細的列舉在標題的下方。

每個.html文件都有一個與之對應的.json文件，用結構化的方式表述相同的內容。這個功能是實驗性的，用以加強對IDE的支持以及其餘與文檔相關的事務。

每個.html與.json文件都基於node資源樹中doc/api/文件夾內相對應的.macrkdown文件。該文檔使用tools/doc/generate.js程序生成的，其HTML模板爲 doc/temlplate.html文件。

 

穩定性標識

在整篇文檔中，咱們將看到章節的穩定性標識。Node.js的API是在不斷變化的，隨着它的成熟，其中一些部分必然比其餘部分更加穩定。那些被證實可信賴的部分將不會被改變，而一些新的實驗性的分支，或者有害的部分將被從新設計。

如下是穩定性標識：

穩定性 0 棄用的
這項功能被證實是有問題的，而且正在被計劃修改。請不要依賴於它。使用這個功能將會致使一些警告以及一些不可預知的兼容性問題。

穩定性 1 實驗性的
這樣功能是最近被引進，有可能在未來的版本中被更改或移除。請試着使用它並提交反饋。若是他解決了一個對你來講很是重要的用例，請告知node核心小組。

穩定性 2 不穩定的
這個API正在穩定的過程當中，可是尚未通過足夠的測試證實其足夠穩定。若是合理的話，向後的兼容性將被保留。

穩定性 3 穩定的
這個API被充分的證實，但在清理底層代碼時將致使一些細微的變化。向後的兼容性將被保證。

穩定性 4 API凍結
這個API在產品中通過了大量的測試，並再也不準備改變。

穩定性 5 鎖定的
除非發現了很是嚴重得缺陷，不然這段代碼將再也不被更改。請不要建議更改這個部分，這些建議將被拒絕。

JSON輸出

穩定性 1 實驗性的

在markdown中，每個HTML文件都有一個與之對應的，擁有相同數據的json文件。

這個功能始於v0.6.12版本，是一個實驗性的功能。