supra-ts-sdk - v2.0.0
    Preparing search index...

    Class SupraRateLimitError

    SupraRateLimitError is thrown when the node answers HTTP 429. retryAfterSeconds is the number of seconds the node asks the caller to wait: the retry_after_seconds field of the error body, or the Retry-After header when the body has none. It is undefined when the node gives neither.

    Hierarchy (View Summary)

    Index
    • 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

    • Returns {
          name: string;
          message: string;
          status: number;
          statusText: string;
          url: string;
          data: unknown;
          major_status: string | undefined;
          sub_status: number | undefined;
          retryAfterSeconds: number | undefined;
      }

    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.

    status: number
    statusText: string
    url: string
    data?: unknown

    The parsed response body: the node's error body, or the raw text when it is not JSON.

    major_status: string | undefined

    The name of the Move VM status code that the error reports (for example SEQUENCE_NUMBER_TOO_OLD, LINKER_ERROR or ABORTED; see MoveVmError), or undefined when the error carries none. Any status name the node emits is passed through, including names MoveVmError does not list.

    sub_status: number | undefined

    The sub status of the Move VM status: the abort code of an ABORTED status. undefined when the error carries none.

    retryAfterSeconds: number | undefined
    cause?: unknown
    name: string
    message: string
    stack?: string