Inttegro TypeScript SDK - v8.2.0
    Preparing search index...

    Class InttegroRateLimitError

    Rate limit error

    Hierarchy (View Summary)

    Index
    constructor
    cause? code? detail? errorDocument? fixCode? message name report? requestId? retryAfter? stack? statusCode? type? url? stackTraceLimit
    captureStackTrace fromResponse prepareStackTrace

    • Parameters

      • message: string
      • statusCode: number = 429
      • OptionalretryAfter: number
      • Optionalcode: string
      • Optionaltype: string
      • Optionalurl: string
      • Optionaldetail: string
      • OptionalfixCode: string
      • Optionalcause: string
      • OptionalerrorDocument: APIErrorDocument
      • OptionalrequestId: string

      Returns InttegroRateLimitError

    cause?: string

    Underlying category of failure

    code?: string

    Error code from API

    detail?: string

    Detailed error explanation

    errorDocument?: APIErrorDocument

    Original decoded API error document

    fixCode?: string

    Suggested resolution

    message: string
    name: string
    report?: ErrorReport

    Privacy-safe report generated only when error reporting is configured.

    requestId?: string

    API request identifier, when returned by the server.

    retryAfter?: number

    When the rate limit resets (timestamp)

    stack?: string
    statusCode?: number

    HTTP status code

    type?: string

    Error type

    url?: string

    Error reference URL

    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.

    • 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

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods