2023-07-13 09:09:17 +00:00
# aggregate-error
2020-05-04 18:50:13 +01:00
> Create an error from multiple errors
2023-07-13 09:09:17 +00:00
* Note: With [Node.js 15](https://medium.com/@nodejs/node-js-v15-0-0-is-here-deb00750f278), there's now a built-in [`AggregateError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AggregateError) type. *
2020-05-04 18:50:13 +01:00
## Install
```
$ npm install aggregate-error
```
## Usage
``` js
2023-07-13 09:09:17 +00:00
import AggregateError from 'aggregate-error' ;
2020-05-04 18:50:13 +01:00
const error = new AggregateError ( [ new Error ( 'foo' ) , 'bar' , { message : 'baz' } ] ) ;
throw error ;
/*
AggregateError:
Error: foo
at Object.<anonymous> (/Users/sindresorhus/dev/aggregate-error/example.js:3:33)
Error: bar
at Object.<anonymous> (/Users/sindresorhus/dev/aggregate-error/example.js:3:13)
Error: baz
at Object.<anonymous> (/Users/sindresorhus/dev/aggregate-error/example.js:3:13)
at AggregateError (/Users/sindresorhus/dev/aggregate-error/index.js:19:3)
at Object.<anonymous> (/Users/sindresorhus/dev/aggregate-error/example.js:3:13)
at Module._compile (module.js:556:32)
at Object.Module._extensions..js (module.js:565:10)
at Module.load (module.js:473:32)
at tryModuleLoad (module.js:432:12)
at Function.Module._load (module.js:424:3)
at Module.runMain (module.js:590:10)
at run (bootstrap_node.js:394:7)
at startup (bootstrap_node.js:149:9)
*/
2023-07-13 09:09:17 +00:00
for ( const individualError of error . errors ) {
2020-05-04 18:50:13 +01:00
console . log ( individualError ) ;
}
//=> [Error: foo]
//=> [Error: bar]
//=> [Error: baz]
```
## API
### AggregateError(errors)
2023-07-13 09:09:17 +00:00
Returns an `Error` .
2020-05-04 18:50:13 +01:00
#### errors
2023-07-13 09:09:17 +00:00
Type: `Array<Error|object|string>`
2020-05-04 18:50:13 +01:00
2023-07-13 09:09:17 +00:00
If a string, a new `Error` is created with the string as the error message.\
2020-05-04 18:50:13 +01:00
If a non-Error object, a new `Error` is created with all properties from the object copied over.