satim-module - v1.0.0
    Preparing search index...

    Class SatimUnexpectedResponseError

    Transport or protocol failure communicating with the SATIM gateway.

    Categories:

    • "network"fetch rejection unrelated to timeout (DNS, connection refused).
    • "timeout"AbortController fired the per-request timeout. Carries isTimeout: true.
    • "parse" — gateway response body was not valid JSON.
    • "http" — non-2xx HTTP status. Carries httpStatus.
    • "gateway" — gateway returned a non-zero ErrorCode not in {1,3,4,5,6,7}, or a malformed response shape.
    • "circuit_open" — circuit breaker rejected the request without dispatching.
    • "unknown" — fallback for unclassified failures.

    Also thrown by ConfirmResponse.verifyAmount() when the captured amount does not match the expected amount, and by response constructors when the gateway payload fails runtime schema validation.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    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.

    errorCategory: SatimErrorCategory
    gatewayErrorCode?: string
    gatewayErrorMessage?: string
    isTimeout: boolean
    httpStatus?: number
    cause?: unknown
    name: string
    message: string
    stack?: string

    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