Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【Node.js24.x】Object::AggregateError()メソッドの使い方

AggregateErrorメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

AggregateErrorメソッドは、複数のエラーを一つのエラーオブジェクトとしてまとめ、効率的に扱うことを可能にするメソッドです。このメソッドは、特に複数の非同期処理が並行して実行され、それぞれが独立してエラーを発生させた場合に、それらのエラーを一括して捕捉し、処理するために設計されています。

AggregateErrorメソッドによって生成されるオブジェクトは、発生した全てのエラーをerrorsプロパティに配列として保持します。これにより、個々のエラーを個別に処理する手間を省き、システム全体のエラーハンドリングを簡潔かつ効率的に行えます。Promise.allSettled()Promise.any()のようなPromiseコンビネーターを使用する際に、複数のPromiseが失敗した場合のエラー情報を集約する目的でよく利用されます。

このメソッドは、エラー発生時の状況をより詳細に把握し、適切なリカバリ処理やログ記録を行う上で非常に有用です。一般的なErrorオブジェクトと同様に、エラーに関するメッセージをmessageプロパティに持つこともできます。複数のエラーが発生しても、一貫した方法でエラーを管理できるため、堅牢なアプリケーション開発に貢献します。

構文(syntax)

1new AggregateError([new Error('サブエラー1'), new TypeError('サブエラー2')], '複数の操作が失敗しました', { cause: '上位のエラー原因' });

引数(parameters)

errors, message, options

  • errors: Array<any>: 発生した複数のエラーオブジェクトの配列
  • message: string: AggregateError 自体の説明メッセージ
  • options: object: オプションを指定するオブジェクト (例: cause)

戻り値(return)

AggregateError

AggregateErrorは、複数のエラーをまとめて表現するためのエラーオブジェクトです。複数の非同期処理が失敗した場合などに、それらのエラーを一つに集約して返します。

関連コンテンツ

関連プログラミング言語