Plants vs. Zombies: Replanted - v1.0.3
    Preparing search index...

    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

    Indexable

    • [index: number]: Error
    Index

    Constructors

    • Parameters

      • Optionalmessage: string

      Returns AggregateError

    • Parameters

      Returns AggregateError

    Properties

    cause?: unknown
    length: number
    message: string
    name: string
    stack?: string
    stackTraceLimit: number

    The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

    The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

    If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

    Methods

    • Parameters

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

      Returns boolean

    • Parameters

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

      Returns AggregateError

    • Parameters

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

      Returns undefined

    • Parameters

      • searchElement: Error
      • OptionalfromIndex: number

      Returns number

    • Parameters

      • Optionalseparator: string

      Returns string

    • Parameters

      • searchElement: Error
      • OptionalfromIndex: number

      Returns number

    • Parameters

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

      Returns AggregateError

    • Returns Error

    • Parameters

      • ...errors: Error[]

      Returns number

    • Parameters

      • callback: (accumulator: any, element: Error, index: number, array: AggregateError) => any
      • OptionalinitialValue: any

      Returns any

    • Parameters

      • callback: (
            previousValue: any,
            element: Error,
            index: number,
            array: AggregateError,
        ) => any
      • OptionalinitialValue: any

      Returns any

    • Returns Error

    • Parameters

      • Optionalbegin: number
      • Optionalend: number

      Returns AggregateError

    • Parameters

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

      Returns boolean

    • Parameters

      • OptionalcompareFunction: (errLeft: Error, errRight: Error) => number

      Returns AggregateError

    • Parameters

      • ...errors: Error[]

      Returns number

    • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

      const myObject = {};
      Error.captureStackTrace(myObject);
      myObject.stack; // Similar to `new Error().stack`

      The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

      The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

      The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

      function a() {
      b();
      }

      function b() {
      c();
      }

      function c() {
      // Create an error without stack trace to avoid calculating the stack trace twice.
      const { stackTraceLimit } = Error;
      Error.stackTraceLimit = 0;
      const error = new Error();
      Error.stackTraceLimit = stackTraceLimit;

      // Capture the stack trace above function b
      Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
      throw error;
      }

      a();

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void