このドキュメントについて
Node.js の公式 API リファレンスドキュメントへようこそ！
Node.js は、V8 JavaScript エンジン上に構築された JavaScript ランタイムです。
貢献
このドキュメントのエラーはissue トラッカーで報告してください。プルリクエストを送信する方法については、貢献ガイドを参照してください。
安定性インデックス
ドキュメント全体を通して、セクションの安定性の指標が示されています。一部の API は、非常に実績があり、非常に信頼されているため、まったく変更される可能性が低いものです。その他は、真新しい実験的なものや、危険であることがわかっているものです。
安定性インデックスは次のとおりです。
[安定性: 0 - 非推奨]
安定性: 0 安定性: 0 - 非推奨。この機能は警告を発する可能性があります。後方互換性は保証されません。
[安定性: 1 - 実験的]
安定性: 1 安定性: 1 - 実験的。この機能はセマンティックバージョニングのルールに従いません。非後方互換の変更または削除が将来のリリースで行われる可能性があります。本番環境でのこの機能の使用はお勧めしません。
[安定性: 2 - 安定]
安定性: 2 安定性: 2 - 安定。npm エコシステムとの互換性が最優先事項です。
[安定性: 3 - レガシー]
安定性: 3 安定性: 3 - レガシー。この機能が削除される可能性は低く、セマンティックバージョニングの保証は引き続き適用されますが、積極的にメンテナンスされておらず、他の代替手段が利用可能です。
機能は、その使用に害がなく、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) 安定 |
Modules: node:module API | (1) .2 - リリース候補 (非同期バージョン) 安定性: 1.1 - アクティブ開発中 (同期バージョン) |
| Modules: CommonJS modules | (2) 安定 |
| Modules: TypeScript | (1) .1 - アクティブ開発中 |
| OS | (2) 安定 |
| Path | (2) 安定 |
| パフォーマンス測定 API | (2) 安定 |
| Punycode | (0) 非推奨 |
| クエリ文字列 | (2) 安定 |
| Readline | (2) 安定 |
| REPL | (2) 安定 |
| 単一実行可能アプリケーション | (1) .1 - アクティブ開発中 |
| SQLite | (1) .1 - アクティブ開発中。 |
| Stream | (2) 安定 |
| 文字列デコーダ | (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 の類似機能があります。それでも、動作の違いは避けられない場合があります。