SW Combine SDK
    Preparing search index...

    Class SWCError

    Custom error class for SW Combine API errors

    Hierarchy

    • Error
      • SWCError
    Index

    Constructors

    Properties

    cause?: Error

    Original error that caused this error

    message: string
    name: string
    requestId?: string

    Request ID from API response

    response?: any

    Original API error response

    retryable: boolean

    Whether this error can be retried

    retryAfter?: number

    Seconds to wait before retrying (for rate limit errors)

    stack?: string
    statusCode?: number

    HTTP status code if applicable

    Error type discriminator

    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

    • Get a user-friendly error message

      Returns string

    • 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

    • Create an error from an HTTP status code and response

      Parameters

      • statusCode: number
      • response: any
      • OptionalrequestId: string

      Returns SWCError