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

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

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

貢献#

このドキュメントのエラーは、イシュートラッカーで報告してください。貢献ガイドを参照して、プルリクエストを送信する方法を確認してください。

安定性インデックス#

ドキュメント全体を通して、セクションの安定性を示す指標があります。一部のAPIは非常に確立されており、依存されているため、変更されることはまずありません。一方、新しく実験的なものや、危険性が知られているものもあります。

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

安定性：0 - 非推奨。この機能は警告を出す場合があります。後方互換性は保証されません。

安定性：1 - 実験的。この機能はセマンティック バージョニングのルールに従っていません。後方互換性のない変更や削除は、将来のリリースでいつでも発生する可能性があります。本番環境でのこの機能の使用はお勧めしません。

実験的機能は段階に分類されます。

  • 1.0 - 開発初期段階。この段階の実験的機能は未完成であり、大幅な変更が行われる可能性があります。
  • 1.1 - アクティブな開発段階。この段階の実験的機能は、最低限の機能が使える状態に近づいています。
  • 1.2 - リリース候補。この段階の実験的機能は、安定版になる準備が整っているはずです。これ以上の破壊的な変更は予想されませんが、ユーザーからのフィードバックに応じて発生する可能性があります。この機能が安定版としてマークされる準備ができていることを確認するために、ユーザーテストとフィードバックを歓迎します。

安定性：2 - 安定版。npm エコシステムとの互換性は最優先事項です。

安定性：3 - レガシー。この機能は削除される可能性は低いものの、セマンティック バージョニングの保証の対象であり、もはやアクティブに保守されておらず、他の代替手段があります。

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

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

安定性の概要#

API安定性
アサーション(2) 安定版
非同期フック(1) 実験的
非同期コンテキスト追跡(2) 安定版
バッファ(2) 安定版
子プロセス(2) 安定版
クラスタ(2) 安定版
コンソール(2) 安定版
暗号化(2) 安定版
診断チャネル(2) 安定版
DNS(2) 安定版
ドメイン(0) 非推奨
ファイルシステム(2) 安定版
HTTP(2) 安定版
HTTP/2(2) 安定版
HTTPS(2) 安定版
インスペクタ(2) 安定版
モジュール：node:module API(1) .2 - リリース候補
モジュール：CommonJS モジュール(2) 安定版
OS(2) 安定版
パス(2) 安定版
パフォーマンス測定API(2) 安定版
Punycode(0) 非推奨
クエリ文字列(2) 安定版
Readline(2) 安定版
REPL(2) 安定版
単一実行可能アプリケーション(1) .1 - アクティブな開発段階
ストリーム(2) 安定版
文字列デコーダ(2) 安定版
テストランナー(2) 安定版
タイマー(2) 安定版
TLS (SSL)(2) 安定版
トレースイベント(1) 実験的
TTY(2) 安定版
UDP/データグラムソケット(2) 安定版
URL(2) 安定版
ユーティリティ(2) 安定版
VM (JavaScriptの実行)(2) 安定版
Web Crypto API(2) 安定版
Web Streams API(2) 安定版
WebAssembly システムインターフェース (WASI)(1) 実験的
ワーカー スレッド(2) 安定版
Zlib(2) 安定版

JSON出力#

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

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

システムコールとマニュアルページ#

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

ほとんどのUnixシステムコールにはWindowsのアナログがありますが、動作の違いは避けられない場合があります。