# aggregate-error

> Create an error from multiple errors

Latest version **5.0.0** (published 2023-09-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install aggregate-error
pnpm add aggregate-error
yarn add aggregate-error
bun add aggregate-error
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.0.0 |
| Published | 2023-09-14 |
| First published | 2016-09-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >=18 |
| Dependencies | 2 |
| Unpacked size | 6.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 247 |
| Author | Sindre Sorhus |
| Maintainers | sindresorhus |
| Keywords | aggregate, error, combine, multiple, many, collection, iterable, iterator |

## Links

- npm: https://www.npmjs.com/package/aggregate-error
- Repository: https://github.com/sindresorhus/aggregate-error
- Homepage: https://github.com/sindresorhus/aggregate-error#readme
- Issues: https://github.com/sindresorhus/aggregate-error/issues
- Funding: https://github.com/sponsors/sindresorhus
- npm.io page: https://npm.io/package/aggregate-error

## Dependencies (2)

- [clean-stack](https://npm.io/package/clean-stack.md) ^5.2.0
- [indent-string](https://npm.io/package/indent-string.md) ^5.0.0

## Alternatives

- [@sentry/react-native](https://npm.io/package/@sentry/react-native.md) — 2.6M weekly downloads
- [@ardatan/aggregate-error](https://npm.io/package/@ardatan/aggregate-error.md) — 708.1K weekly downloads
- [custom-error-generator](https://npm.io/package/custom-error-generator.md) — 2.0K weekly downloads
- [@technik-sde/prosemirror-recreate-transform](https://npm.io/package/@technik-sde/prosemirror-recreate-transform.md) — 1.5K weekly downloads
- [@suchipi/error-utils](https://npm.io/package/@suchipi/error-utils.md) — 78 weekly downloads

## Recent versions

- 5.0.0 (latest) — 2023-09-14
- 4.0.1 — 2022-05-08
- 4.0.0 — 2021-04-17
- 3.1.0 — 2020-08-21
- 3.0.1 — 2019-10-04
- 3.0.0 — 2019-04-01
- 2.2.0 — 2019-03-03
- 2.1.0 — 2019-02-28
- 2.0.0 — 2018-12-26
- 1.0.0 — 2017-01-13
- 0.1.0 — 2016-09-13

## README

# 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

```sh
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.

---
_Source: https://npm.io/package/aggregate-error · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._