The AggregateError
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 by Promise.any()
, when all promises passed to it reject.
AggregateError
Constructor
-
AggregateError()
-
Creates a new
AggregateError
object.
Instance properties
-
AggregateError.prototype.message
-
Error message, defaults to
""
. -
AggregateError.prototype.name
-
Error name, defaults to
AggregateError
. -
AggregateError
:errors
-
An array that essentially reflects the iterable with which the
AggregateError
was instantiated; for example, if theAggregateError
was created using theAggregateError()
constructor, an array produced from whatever iterable was passed to the constructor as its first argument.
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" ] }
Specifications
Browser compatibility
Desktop | Mobile | Server | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | Deno | Node.js | |
AggregateError |
85
|
85
|
79
|
No
|
71
|
14
|
85
|
85
|
79
|
60
|
14
|
14.0
|
1.2
|
15.0.0
|
AggregateError |
85
|
85
|
79
|
No
|
71
|
14
|
85
|
85
|
79
|
60
|
14
|
14.0
|
1.2
|
15.0.0
|
See also
© 2005–2022 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AggregateError