このドキュメントについて
Node.js の公式 API リファレンスドキュメントへようこそ！
Node.js は V8 JavaScript エンジン上に構築された JavaScript ランタイムです。
コントリビューション
このドキュメントのエラーは、issue tracker に報告してください。プルリクエストの送信方法については、貢献ガイド を参照してください。
安定度インデックス
ドキュメント全体を通して、セクションの安定度が表示されています。一部の API は十分に実績があり、信頼性が高いため、まったく変更される可能性は低いでしょう。一方、ごく新しい実験的なものや、危険であることがわかっているものもあります。
安定度インデックスは次のとおりです。
[安定度: 0 - 非推奨]
安定度: 0 安定度: 0 - 非推奨。この機能は警告を発する場合があります。後方互換性は保証されません。
[安定度: 1 - 試験的]
安定度: 1 安定度: 1 - 試験的。この機能は セマンティックバージョニング のルールに従いません。後方互換性のない変更や削除は、将来のリリースで発生する可能性があります。この機能の利用は、本番環境では推奨されません。
[安定度: 2 - 安定]
安定度: 2 安定度: 2 - 安定。npm エコシステムとの互換性が最優先事項です。
[安定度: 3 - レガシー]
安定度: 3 安定度: 3 - レガシー。この機能は削除される可能性は低く、セマンティックバージョニングの保証も適用されますが、積極的なメンテナンスは行われておらず、他の代替手段が利用可能です。
レガシー機能は、その使用に害がなく、npm エコシステム内で広く利用されている場合に、非推奨ではなくレガシーとしてマークされます。レガシー機能で見つかったバグは修正されない可能性があります。
特にライブラリを作成する場合は、試験的な機能を使用する際には注意してください。ユーザーは、試験的な機能が使用されていることに気付いていない可能性があります。試験的な API の変更が発生すると、バグや動作の変化がユーザーを驚かせる可能性があります。驚きを避けるために、試験的な機能の使用にはコマンドラインフラグが必要になる場合があります。試験的な機能は、警告 を発することもあります。
安定性の概要
| API | 安定性 |
|---|---|
| Assert | (2) Stable |
| Async hooks | (1) Experimental |
| Asynchronous context tracking | (2) Stable |
| Buffer | (2) Stable |
| Child process | (2) Stable |
| Cluster | (2) Stable |
| Console | (2) Stable |
| Crypto | (2) Stable |
| Diagnostics Channel | (2) Stable |
| DNS | (2) Stable |
| Domain | (0) Deprecated |
| File system | (2) Stable |
| HTTP | (2) Stable |
| HTTP/2 | (2) Stable |
| HTTPS | (2) Stable |
| Inspector | (2) Stable |
Modules: node:module API | (1) .2 - リリース候補 (非同期バージョン) 安定性: 1.1 - 活発な開発 (同期バージョン) |
| Modules: CommonJS modules | (2) Stable |
| Modules: TypeScript | (1) .1 - 活発な開発 |
| OS | (2) Stable |
| Path | (2) Stable |
| Performance measurement APIs | (2) Stable |
| Punycode | (0) Deprecated |
| Query string | (2) Stable |
| Readline | (2) Stable |
| REPL | (2) Stable |
| Single executable applications | (1) .1 - 活発な開発 |
| SQLite | (1) .1 - 活発な開発. |
| Stream | (2) Stable |
| String decoder | (2) Stable |
| Test runner | (2) Stable |
| Timers | (2) Stable |
| TLS (SSL) | (2) Stable |
| Trace events | (1) Experimental |
| TTY | (2) Stable |
| UDP/datagram sockets | (2) Stable |
| URL | (2) Stable |
| Util | (2) Stable |
| VM (executing JavaScript) | (2) Stable |
| Web Crypto API | (2) Stable |
| Web Streams API | (2) Stable |
| WebAssembly System Interface (WASI) | (1) Experimental |
| Worker threads | (2) Stable |
| Zlib | (2) Stable |
JSON 出力
追加: v0.6.12
すべての .html ドキュメントには、対応する .json ドキュメントがあります。これは、IDE やドキュメントを利用するその他のユーティリティのためのものです。
システムコールと man ページ
システムコールをラップする Node.js 関数は、その旨をドキュメントに記載します。ドキュメントは、システムコールの仕組みを記述した対応する man ページにリンクしています。
ほとんどの Unix システムコールには、Windows の類似機能があります。それでも、動作の違いは避けられない場合があります。