Node.js v0.11.11 マニュアル & ドキュメンテーション

About this Documentation#

このドキュメントのゴールは、Node.js の API についてリファレンスとしても， 概念的な視点としても，包括的な説明をすることです。 それぞれのセクションは組込のモジュールまたは高水準の概念について記述します。

必要に応じて、プロパティの型やメソッドの引数、そしてイベントハンドラに 与えられる引数などの詳細は見出し直後のリストで与えられます。

すべての .html ドキュメントは、対応する .json ドキュメントを持ちます。 それは同じ情報を同様の構造で表現します。 これは実験的で、ドキュメントをプログラム的に扱いたい IDE や他の ユーティリティのために加えられました。

すべての .html と .json ファイルは、node ソースツリーの doc/api/ フォルダにある、対応する .markdown ファイルを基に生成されます。 ドキュメントの生成には tools/doc/generate.js が使われます。 HTML のテンプレートは doc/template.html にあります。

Stability Index#

ドキュメント全体を通して、セクションの安定度に関する目安を見ることが できるでしょう。 Node.js の API はまだ少し変更されます。 それが成熟することにより、ある部分は他よりも信頼できるようになります。 いくつかはそのように証明され、したがって信頼され、それらはおそらく 変更されそうもありません。 その他は新しくて実験的か、危険が知られていたり、再実装が始まっていたりします。

Stability (安定度) を以下のように示します: 

Stability: 0 - 廃止予定
この機能には問題があることが知られていて、変更が計画されています。
これに依存しないでください。この機能を使用すると警告が出されるでしょう。
後方互換性を期待すべきではありません。
Stability: 1 - 実験的
この機能は最近導入され、将来のバージョンで変更されるか削除されるかもしれません。
それを試してフィードバックをしてください。
重要なユースケースで使われるなら、node コアチームに教えてください。
Stability: 2 - 不安定
API は安定化の途中ですが、まだ安定していると考えられるほどには
現実世界でテストされていません。
もし合理的なら後方互換性が維持されるでしょう。
Stability: 3 - 安定
API は要求を満たすことがわかりましたが、実装コードをクリーンナップするために
小さな変更が行われるかもしれません。
後方互換性は保証されます。
Stability: 4 - API 凍結
API は実運用で広範囲にテストされており、おそらく変更されることはありません。
Stability: 5 - 固定
深刻なバグが見つからない限り、コードは変更されません。
このエリアの変更を提案しないでください; そえは拒否されます。

JSON Output#

Stability: 1 - 実験的

markdown から作られる全ての HTML ファイルは、対応する JSON ファイルを持ちます。

これは v0.6.12 からの新機能で、実験的です。