AggregateError

BaselineWidely available *

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2020.

* Some parts of this feature may have varying levels of support.

TheAggregateError object represents an error when several errors need to be wrapped in a single error. It is thrown when multiple errors need to be reported by an operation, for example byPromise.any(), when all promises passed to it reject.

AggregateError is a subclass ofError.

Constructor

AggregateError(): Creates a newAggregateError object.

Instance properties

Also inherits instance properties from its parentError.

These properties are defined onAggregateError.prototype and shared by allAggregateError instances.

AggregateError.prototype.constructor: The constructor function that created the instance object. ForAggregateError instances, the initial value is theAggregateError constructor.
AggregateError.prototype.name: Represents the name for the type of error. ForAggregateError.prototype.name, the initial value is"AggregateError".

These properties are own properties of eachAggregateError instance.

errors: An array representing the errors that were aggregated.

Instance methods

Inherits instance methods from its parentError.

Examples

Catching an AggregateError

Promise.any([Promise.reject(new Error("some error"))]).catch((e) => {  console.log(e instanceof AggregateError); // true  console.log(e.message); // "All Promises rejected"  console.log(e.name); // "AggregateError"  console.log(e.errors); // [ Error: "some error" ]});

Creating an AggregateError

try {  throw new AggregateError([new Error("some error")], "Hello");} catch (e) {  console.log(e instanceof AggregateError); // true  console.log(e.message); // "Hello"  console.log(e.name); // "AggregateError"  console.log(e.errors); // [ Error: "some error" ]}