このドキュメントについて#

Node.js の公式 API リファレンスドキュメントへようこそ！

Node.js は V8 JavaScript エンジン上に構築された JavaScript ランタイムです。

コントリビューション#

このドキュメントの誤りはイシュートラッカーで報告してください。プルリクエストを送信する方法については、コントリビューションガイドを参照してください。

安定性インデックス#

ドキュメント全体を通して、セクションの安定性についての表示があります。一部の API は実績があり、広く依存されているため、今後変更される可能性はほとんどありません。その他は、全く新しい実験的なものであったり、危険であることが知られています。

安定性インデックスは以下の通りです

安定性: 0 - 廃止予定 (Deprecated)。この機能は警告を出力する可能性があります。後方互換性は保証されません。

安定性: 1 - 実験的 (Experimental)。この機能はセマンティックバージョニングのルールには従いません。後方互換性のない変更や削除が、将来のどのリリースでも行われる可能性があります。本番環境でのこの機能の使用は推奨されません。

実験的な機能はステージに細分化されます

  • 1.0 - 初期開発段階。このステージの実験的な機能は未完成であり、大幅な変更が加えられる可能性があります。
  • 1.1 - 積極的開発段階。このステージの実験的な機能は、実用最小限の製品に近づいています。
  • 1.2 - リリース候補。このステージの実験的な機能は、安定版になる準備が整っていることが期待されます。これ以上の破壊的変更は想定されていませんが、ユーザーからのフィードバックや機能の基盤となる仕様の進展に応じて発生する可能性があります。この機能が安定版としてマークされる準備が整ったことを確認できるよう、ユーザーによるテストとフィードバックを奨励します。

実験的な機能は、通常、安定版に昇格するか、廃止予定のサイクルを経ずに削除されることで、実験的なステータスから外れます。

安定性: 2 - 安定 (Stable)。npm エコシステムとの互換性は高い優先事項です。

安定性: 3 - レガシー (Legacy)。この機能が削除される可能性は低く、セマンティックバージョニングの保証対象ではありますが、もはや積極的にメンテナンスされておらず、他の代替手段が利用可能です。

機能が使用されても害がなく、npm エコシステム内で広く依存されている場合、廃止予定ではなくレガシーとしてマークされます。レガシー機能で見つかったバグが修正される可能性は低いです。

実験的な機能を利用する際、特にライブラリを作成する場合は注意してください。ユーザーは実験的な機能が使用されていることに気づいていないかもしれません。実験的な API に変更があった場合、バグや挙動の変更がユーザーを驚かせる可能性があります。予期せぬ事態を避けるため、実験的な機能の使用にはコマンドラインフラグが必要になることがあります。また、実験的な機能は警告を出力することがあります。

安定性の概要#

API安定性
Assert(2) 安定
Async hooks(1) 実験的
非同期コンテキストの追跡(2) 安定
Buffer(2) 安定
子プロセス(2) 安定
Cluster(2) 安定
Console(2) 安定
Crypto(2) 安定
Diagnostics Channel(2) 安定
DNS(2) 安定
Domain(0) 廃止予定
ファイルシステム(2) 安定
HTTP(2) 安定
HTTP/2(2) 安定
HTTPS(2) 安定
Inspector(2) 安定
モジュール: node:module API(1) .2 - リリース候補 (非同期版) 安定性: 1.1 - 積極的開発段階 (同期版)
モジュール: CommonJS モジュール(2) 安定
モジュール: TypeScript(1) .2 - リリース候補
OS(2) 安定
Path(2) 安定
パフォーマンス計測 API(2) 安定
Punycode(0) 廃止予定
クエリストリング(2) 安定
Readline(2) 安定
REPL(2) 安定
単一実行可能ファイルアプリケーション(1) .1 - 積極的開発段階
SQLite(1) .1 - 積極的開発段階。
Stream(2) 安定
String decoder(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 System Interface (WASI)(1) 実験的
ワーカースレッド(2) 安定
Zlib(2) 安定

JSON 出力#

追加されたバージョン: v0.6.12

すべての .html ドキュメントには、対応する .json ドキュメントがあります。これは、ドキュメントを利用する IDE やその他のユーティリティのためのものです。

システムコールと man ページ#

システムコールをラップする Node.js の関数は、そのことをドキュメントに記載します。ドキュメントは、そのシステムコールの動作を説明する対応する man ページにリンクしています。

ほとんどの Unix システムコールには Windows の類似機能があります。それでも、挙動の違いは避けられない場合があります。