AggregateError() constructor

The AggregateError() constructor creates an error for several errors that need to be wrapped in a single error.

Syntax

new AggregateError(errors)
new AggregateError(errors, message)

Parameters

errors

An iterable of errors, may not actually be Error instances.

messageOptional

An optional human-readable description of the aggregate error.

Examples

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" ]
}

Specifications

Specification
ECMAScript Language Specification (ECMAScript)
# sec-aggregate-error-constructor

Browser compatibility

BCD tables only load in the browser

See also