mirror of
https://github.com/github/codeql-action.git
synced 2025-12-27 17:50:07 +08:00
61 lines
1.7 KiB
Markdown
61 lines
1.7 KiB
Markdown
# aggregate-error
|
|
|
|
> Create an error from multiple errors
|
|
|
|
*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.*
|
|
|
|
## Install
|
|
|
|
```
|
|
$ npm install aggregate-error
|
|
```
|
|
|
|
## Usage
|
|
|
|
```js
|
|
import AggregateError from 'aggregate-error';
|
|
|
|
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)
|
|
*/
|
|
|
|
for (const individualError of error.errors) {
|
|
console.log(individualError);
|
|
}
|
|
//=> [Error: foo]
|
|
//=> [Error: bar]
|
|
//=> [Error: baz]
|
|
```
|
|
|
|
## API
|
|
|
|
### AggregateError(errors)
|
|
|
|
Returns an `Error`.
|
|
|
|
#### errors
|
|
|
|
Type: `Array<Error|object|string>`
|
|
|
|
If a string, a new `Error` is created with the string as the error message.\
|
|
If a non-Error object, a new `Error` is created with all properties from the object copied over.
|