@wailsio/runtime
    Preparing search index...

    Class CancelledRejectionError

    Exception class that will be reported as an unhandled rejection in case a CancellablePromise rejects after being cancelled, or when the oncancelled callback throws or rejects.

    The value of the name property is the string "CancelledRejectionError". The value of the cause property is the reason the promise rejected with.

    Because the original promise was cancelled, a wrapper promise will be passed to the unhandled rejection listener instead. The promise property holds a reference to the original promise.

    Hierarchy

    • Error
      • CancelledRejectionError
    Index

    Constructors

    • Constructs a new CancelledRejectionError instance.

      Parameters

      • promise: CancellablePromise<unknown>

        The promise that caused the error originally.

      • Optionalreason: any

        The rejection reason.

      • Optionalinfo: string

        An optional informative message specifying the circumstances in which the error was thrown. Defaults to the string "Unhandled rejection in cancelled promise.".

      Returns CancelledRejectionError

    Properties

    cause?: unknown
    message: string
    name: string
    promise: CancellablePromise<unknown>

    Holds a reference to the promise that was cancelled and then rejected.

    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

    • 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

    • Indicates whether the argument provided is a built-in Error instance or not.

      Parameters

      • error: unknown

      Returns error is Error