【Node.js24.x】AggregateError::AggregateError()関数の使い方
AggregateError関数の使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
AggregateError関数は、複数のエラーをまとめて一つのエラーオブジェクトとして扱うことを可能にする関数です。これはNode.jsの組み込み機能として提供されており、ECMAScript標準の一部でもあります。
この関数は、発生した複数のエラーのコレクション（通常は配列）と、それらのエラー全体に対するメッセージを引数として受け取ります。そして、それらの情報をカプセル化した新しいAggregateErrorオブジェクトを生成して返します。生成されたAggregateErrorオブジェクトは、標準のErrorクラスを継承しているため、既存のエラー処理メカニズムとシームレスに連携できます。
特に、非同期処理において複数の操作が並行して実行され、そのうちのいくつかが失敗した場合に非常に有用です。例えば、Promise.allSettled()などのPromiseベースのAPIでは、失敗したすべてのPromiseから生じたエラーをまとめてこのAggregateErrorとして報告することがあります。個々のエラーには、AggregateErrorオブジェクトのerrorsプロパティを通じてアクセスできるため、プログラマはエラーの詳細を一つずつ確認し、適切に処理することができます。これにより、複雑なエラーハンドリングが簡潔かつ効率的に行えるようになります。
構文(syntax)
1new AggregateError([new Error('エラー1'), new TypeError('エラー2')], '複数の問題が発生しました');
引数(parameters)
errors, message = undefined, options = undefined
- errors: Array<any> | Iterable<any>: 複数のエラーオブジェクトの配列またはイテラブル
- message: string = undefined: AggregateError に関する説明メッセージ
- options: AggregateErrorOptions | undefined: エラーに関する追加オプション
戻り値(return)
AggregateError
AggregateErrorクラスのコンストラクタです。複数のエラーをまとめて保持するために使用されます。