Class TooManyRequestsError

Error that indicate that the request was throttled.

Hierarchy (View Summary)

Constructors

constructor

Properties

cause? errorCode message name response responseBody retryAfter stack? statusCode prepareStackTrace? stackTraceLimit

Methods

captureStackTrace fromErrorResponse fromPlain fromPlainError unknown

Constructors

constructor

  • new TooManyRequestsError(
        body: {
            error: {
                code:
                    | "RequestCannotBeParsed"
                    | "TokenRequired"
                    | "TokenNotFound"
                    | "SubscriptionNotActive"
                    | "WrongRegion"
                    | "FeatureNotEnabled"
                    | "RequestNotFound"
                    | "VisitorNotFound"
                    | "TooManyRequests"
                    | "429 Too Many Requests"
                    | "StateNotReady"
                    | "Failed";
                message: string;
            };
        },
        response: Response,
    ): TooManyRequestsError

    Parameters

    • body: {
          error: {
              code:
                  | "RequestCannotBeParsed"
                  | "TokenRequired"
                  | "TokenNotFound"
                  | "SubscriptionNotActive"
                  | "WrongRegion"
                  | "FeatureNotEnabled"
                  | "RequestNotFound"
                  | "VisitorNotFound"
                  | "TooManyRequests"
                  | "429 Too Many Requests"
                  | "StateNotReady"
                  | "Failed";
              message: string;
          };
      }
    • response: Response

    Returns TooManyRequestsError

Properties

Optionalcause

cause?: unknown

ReadonlyerrorCode

errorCode: string

message

message: string

name

name: string

Readonlyresponse

response: Response

ReadonlyresponseBody

responseBody: {
    error: {
        code:
            | "RequestCannotBeParsed"
            | "TokenRequired"
            | "TokenNotFound"
            | "SubscriptionNotActive"
            | "WrongRegion"
            | "FeatureNotEnabled"
            | "RequestNotFound"
            | "VisitorNotFound"
            | "TooManyRequests"
            | "429 Too Many Requests"
            | "StateNotReady"
            | "Failed";
        message: string;
    };
}

ReadonlyretryAfter

retryAfter: number = 0

Number of seconds to wait before retrying the request.

Remarks

The value is parsed from the Retry-After header of the response.

Optionalstack

stack?: string

ReadonlystatusCode

statusCode: 429

Static OptionalprepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

StaticstackTraceLimit

stackTraceLimit: number

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

    Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

StaticfromErrorResponse

  • fromErrorResponse(
        body: {
            error: {
                code:
                    | "RequestCannotBeParsed"
                    | "TokenRequired"
                    | "TokenNotFound"
                    | "SubscriptionNotActive"
                    | "WrongRegion"
                    | "FeatureNotEnabled"
                    | "RequestNotFound"
                    | "VisitorNotFound"
                    | "TooManyRequests"
                    | "429 Too Many Requests"
                    | "StateNotReady"
                    | "Failed";
                message: string;
            };
        },
        response: Response,
    ): RequestError<
        number,
        {
            error: {
                code: | "RequestCannotBeParsed"
                | "TokenRequired"
                | "TokenNotFound"
                | "SubscriptionNotActive"
                | "WrongRegion"
                | "FeatureNotEnabled"
                | "RequestNotFound"
                | "VisitorNotFound"
                | "TooManyRequests"
                | "429 Too Many Requests"
                | "StateNotReady"
                | "Failed";
                message: string;
            };
        },
    >

    Parameters

    • body: {
          error: {
              code:
                  | "RequestCannotBeParsed"
                  | "TokenRequired"
                  | "TokenNotFound"
                  | "SubscriptionNotActive"
                  | "WrongRegion"
                  | "FeatureNotEnabled"
                  | "RequestNotFound"
                  | "VisitorNotFound"
                  | "TooManyRequests"
                  | "429 Too Many Requests"
                  | "StateNotReady"
                  | "Failed";
              message: string;
          };
      }
    • response: Response

    Returns RequestError<
        number,
        {
            error: {
                code: | "RequestCannotBeParsed"
                | "TokenRequired"
                | "TokenNotFound"
                | "SubscriptionNotActive"
                | "WrongRegion"
                | "FeatureNotEnabled"
                | "RequestNotFound"
                | "VisitorNotFound"
                | "TooManyRequests"
                | "429 Too Many Requests"
                | "StateNotReady"
                | "Failed";
                message: string;
            };
        },
    >

StaticfromPlain

StaticfromPlainError

Staticunknown

Settings

Member Visibility

On This Page

Constructors
Properties
Methods