52 lines
1.8 KiB
TypeScript
52 lines
1.8 KiB
TypeScript
/**
|
|
Create an error from multiple errors.
|
|
*/
|
|
declare class AggregateError extends Error implements Iterable<Error> {
|
|
readonly name: 'AggregateError';
|
|
|
|
/**
|
|
@param errors - 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.
|
|
@returns An Error that is also an [`Iterable`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Iterators_and_Generators#Iterables) for the individual errors.
|
|
|
|
@example
|
|
```
|
|
import AggregateError = require('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) {
|
|
console.log(individualError);
|
|
}
|
|
//=> [Error: foo]
|
|
//=> [Error: bar]
|
|
//=> [Error: baz]
|
|
```
|
|
*/
|
|
constructor(errors: ReadonlyArray<Error | {[key: string]: any} | string>);
|
|
|
|
[Symbol.iterator](): IterableIterator<Error>;
|
|
}
|
|
|
|
export = AggregateError;
|