Class AggregateError

A collection of errors. AggregateError is an array-like object, with numeric indices and a .length property. It supports all generic array methods such as .forEach directly.

AggregateErrors are caught in .error handlers, even if the contained errors are not operational.

Promise.some and Promise.any use AggregateError as rejection reason when they fail.

Hierarchy

Error
- AggregateError

Implements

ArrayLike<Error>

Indexable

[index: number]: Error

Index

Constructors

constructor

new AggregateError(message?: string): AggregateError
Parameters
- Optional message: string
Returns AggregateError
Inherited from Error.constructor
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1059

Properties

length

length: number

message

message: string

name

name: string

`Optional` stack

stack?: string

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Type declaration

- (err: Error, stackTraces: CallSite[]): any
- Optional override for formatting stack traces
  
  See
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any

`Static` stackTraceLimit

stackTraceLimit: number

Methods

every

every(callback: ((element: Error, index: number, array: AggregateError) => boolean), thisArg?: any): boolean
Parameters
- callback: ((element: Error, index: number, array: AggregateError) => boolean)
  - - (element: Error, index: number, array: AggregateError): boolean
    - Parameters
      
      element: Error
      
      index: number
      
      array: AggregateError
      
      Returns boolean
- Optional thisArg: any
Returns boolean
- Defined in node_modules/@types/bluebird/index.d.ts:1191

filter

filter(callback: ((element: Error, index: number, array: AggregateError) => boolean), thisArg?: any): AggregateError
Parameters
- callback: ((element: Error, index: number, array: AggregateError) => boolean)
  - - (element: Error, index: number, array: AggregateError): boolean
    - Parameters
      
      element: Error
      
      index: number
      
      array: AggregateError
      
      Returns boolean
- Optional thisArg: any
Returns AggregateError
- Defined in node_modules/@types/bluebird/index.d.ts:1188

forEach

forEach(callback: ((element: Error, index: number, array: AggregateError) => void), thisArg?: any): undefined
Parameters
- callback: ((element: Error, index: number, array: AggregateError) => void)
  - - (element: Error, index: number, array: AggregateError): void
    - Parameters
      
      element: Error
      
      index: number
      
      array: AggregateError
      
      Returns void
- Optional thisArg: any
Returns undefined
- Defined in node_modules/@types/bluebird/index.d.ts:1189

indexOf

indexOf(searchElement: Error, fromIndex?: number): number
Parameters
- searchElement: Error
- Optional fromIndex: number
Returns number
- Defined in node_modules/@types/bluebird/index.d.ts:1193

join

join(separator?: string): string
Parameters
- Optional separator: string
Returns string
- Defined in node_modules/@types/bluebird/index.d.ts:1182

lastIndexOf

lastIndexOf(searchElement: Error, fromIndex?: number): number
Parameters
- searchElement: Error
- Optional fromIndex: number
Returns number
- Defined in node_modules/@types/bluebird/index.d.ts:1194

map

map(callback: ((element: Error, index: number, array: AggregateError) => boolean), thisArg?: any): AggregateError
Parameters
- callback: ((element: Error, index: number, array: AggregateError) => boolean)
  - - (element: Error, index: number, array: AggregateError): boolean
    - Parameters
      
      element: Error
      
      index: number
      
      array: AggregateError
      
      Returns boolean
- Optional thisArg: any
Returns AggregateError
- Defined in node_modules/@types/bluebird/index.d.ts:1192

pop

pop(): Error
Returns Error
- Defined in node_modules/@types/bluebird/index.d.ts:1183

push

push(...errors: Error[]): number
Parameters
- Rest ...errors: Error[]
Returns number
- Defined in node_modules/@types/bluebird/index.d.ts:1184

reduce

reduce(callback: ((accumulator: any, element: Error, index: number, array: AggregateError) => any), initialValue?: any): any
Parameters
- callback: ((accumulator: any, element: Error, index: number, array: AggregateError) => any)
  - - (accumulator: any, element: Error, index: number, array: AggregateError): any
    - Parameters
      
      accumulator: any
      
      element: Error
      
      index: number
      
      array: AggregateError
      
      Returns any
- Optional initialValue: any
Returns any
- Defined in node_modules/@types/bluebird/index.d.ts:1195

reduceRight

reduceRight(callback: ((previousValue: any, element: Error, index: number, array: AggregateError) => any), initialValue?: any): any
Parameters
- callback: ((previousValue: any, element: Error, index: number, array: AggregateError) => any)
  - - (previousValue: any, element: Error, index: number, array: AggregateError): any
    - Parameters
      
      previousValue: any
      
      element: Error
      
      index: number
      
      array: AggregateError
      
      Returns any
- Optional initialValue: any
Returns any
- Defined in node_modules/@types/bluebird/index.d.ts:1196

reverse

reverse(): AggregateError
Returns AggregateError
- Defined in node_modules/@types/bluebird/index.d.ts:1198

shift

shift(): Error
Returns Error
- Defined in node_modules/@types/bluebird/index.d.ts:1185

slice

slice(begin?: number, end?: number): AggregateError
Parameters
- Optional begin: number
- Optional end: number
Returns AggregateError
- Defined in node_modules/@types/bluebird/index.d.ts:1187

some

some(callback: ((element: Error, index: number, array: AggregateError) => boolean), thisArg?: any): boolean
Parameters
- callback: ((element: Error, index: number, array: AggregateError) => boolean)
  - - (element: Error, index: number, array: AggregateError): boolean
    - Parameters
      
      element: Error
      
      index: number
      
      array: AggregateError
      
      Returns boolean
- Optional thisArg: any
Returns boolean
- Defined in node_modules/@types/bluebird/index.d.ts:1190

sort

sort(compareFunction?: ((errLeft: Error, errRight: Error) => number)): AggregateError
Parameters
- Optional compareFunction: ((errLeft: Error, errRight: Error) => number)
  - - (errLeft: Error, errRight: Error): number
    - Parameters
      
      errLeft: Error
      
      errRight: Error
      
      Returns number
Returns AggregateError
- Defined in node_modules/@types/bluebird/index.d.ts:1197

unshift

unshift(...errors: Error[]): number
Parameters
- Rest ...errors: Error[]
Returns number
- Defined in node_modules/@types/bluebird/index.d.ts:1186

`Static` captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void
Inherited from Error.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:4

Class AggregateError

Hierarchy

Implements

Indexable

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional message: string

Returns AggregateError

Properties

length

message

name

Optional stack

Static Optional prepareStackTrace

Type declaration

See

Parameters

err: Error

stackTraces: CallSite[]

Returns any

Static stackTraceLimit

Methods

every

Parameters

callback: ((element: Error, index: number, array: AggregateError) => boolean)

Parameters

element: Error

index: number

array: AggregateError

Returns boolean

Optional thisArg: any

Returns boolean

filter

Parameters

callback: ((element: Error, index: number, array: AggregateError) => boolean)

Parameters

element: Error

index: number

array: AggregateError

Returns boolean

Optional thisArg: any

Returns AggregateError

forEach

Parameters

callback: ((element: Error, index: number, array: AggregateError) => void)

Parameters

element: Error

index: number

array: AggregateError

Returns void

Optional thisArg: any

Returns undefined

indexOf

Parameters

searchElement: Error

Optional fromIndex: number

Returns number

join

Parameters

Optional separator: string

Returns string

lastIndexOf

Parameters

searchElement: Error

Optional fromIndex: number

Returns number

map

Parameters

callback: ((element: Error, index: number, array: AggregateError) => boolean)

Parameters

element: Error

index: number

array: AggregateError

Returns boolean

Optional thisArg: any

`Optional` message: string

`Optional` stack

`Static` `Optional` prepareStackTrace

`Static` stackTraceLimit

`Optional` thisArg: any

`Optional` thisArg: any

`Optional` thisArg: any

`Optional` fromIndex: number

`Optional` separator: string

`Optional` fromIndex: number

`Optional` thisArg: any

`Rest` ...errors: Error[]

`Optional` initialValue: any

`Optional` initialValue: any

`Optional` begin: number

`Optional` end: number

`Optional` thisArg: any

`Optional` compareFunction: ((errLeft: Error, errRight: Error) => number)

`Rest` ...errors: Error[]

`Static` captureStackTrace

`Optional` constructorOpt: Function