Class TooManyRequestsError

Error that indicate that the request was throttled.

Hierarchy (View Summary)

Constructors

constructor

Properties

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

Methods

captureStackTrace fromErrorResponse unknown

Constructors

constructor

  • new TooManyRequestsError(
        body: {
            error: {
                code:
                    | "failed"
                    | "request_cannot_be_parsed"
                    | "secret_api_key_required"
                    | "secret_api_key_not_found"
                    | "public_api_key_required"
                    | "public_api_key_not_found"
                    | "subscription_not_active"
                    | "wrong_region"
                    | "feature_not_enabled"
                    | "request_not_found"
                    | "visitor_not_found"
                    | "too_many_requests"
                    | "state_not_ready"
                    | "event_not_found"
                    | "missing_module"
                    | "payload_too_large"
                    | "service_unavailable"
                    | "ruleset_not_found";
                message: string;
            };
        },
        response: Response,
    ): TooManyRequestsError

    Parameters

    • body: {
          error: {
              code:
                  | "failed"
                  | "request_cannot_be_parsed"
                  | "secret_api_key_required"
                  | "secret_api_key_not_found"
                  | "public_api_key_required"
                  | "public_api_key_not_found"
                  | "subscription_not_active"
                  | "wrong_region"
                  | "feature_not_enabled"
                  | "request_not_found"
                  | "visitor_not_found"
                  | "too_many_requests"
                  | "state_not_ready"
                  | "event_not_found"
                  | "missing_module"
                  | "payload_too_large"
                  | "service_unavailable"
                  | "ruleset_not_found";
              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:
            | "failed"
            | "request_cannot_be_parsed"
            | "secret_api_key_required"
            | "secret_api_key_not_found"
            | "public_api_key_required"
            | "public_api_key_not_found"
            | "subscription_not_active"
            | "wrong_region"
            | "feature_not_enabled"
            | "request_not_found"
            | "visitor_not_found"
            | "too_many_requests"
            | "state_not_ready"
            | "event_not_found"
            | "missing_module"
            | "payload_too_large"
            | "service_unavailable"
            | "ruleset_not_found";
        message: string;
    };
}

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:
                    | "failed"
                    | "request_cannot_be_parsed"
                    | "secret_api_key_required"
                    | "secret_api_key_not_found"
                    | "public_api_key_required"
                    | "public_api_key_not_found"
                    | "subscription_not_active"
                    | "wrong_region"
                    | "feature_not_enabled"
                    | "request_not_found"
                    | "visitor_not_found"
                    | "too_many_requests"
                    | "state_not_ready"
                    | "event_not_found"
                    | "missing_module"
                    | "payload_too_large"
                    | "service_unavailable"
                    | "ruleset_not_found";
                message: string;
            };
        },
        response: Response,
    ): RequestError<
        number,
        {
            error: {
                code: | "failed"
                | "request_cannot_be_parsed"
                | "secret_api_key_required"
                | "secret_api_key_not_found"
                | "public_api_key_required"
                | "public_api_key_not_found"
                | "subscription_not_active"
                | "wrong_region"
                | "feature_not_enabled"
                | "request_not_found"
                | "visitor_not_found"
                | "too_many_requests"
                | "state_not_ready"
                | "event_not_found"
                | "missing_module"
                | "payload_too_large"
                | "service_unavailable"
                | "ruleset_not_found";
                message: string;
            };
        },
    >

    Parameters

    • body: {
          error: {
              code:
                  | "failed"
                  | "request_cannot_be_parsed"
                  | "secret_api_key_required"
                  | "secret_api_key_not_found"
                  | "public_api_key_required"
                  | "public_api_key_not_found"
                  | "subscription_not_active"
                  | "wrong_region"
                  | "feature_not_enabled"
                  | "request_not_found"
                  | "visitor_not_found"
                  | "too_many_requests"
                  | "state_not_ready"
                  | "event_not_found"
                  | "missing_module"
                  | "payload_too_large"
                  | "service_unavailable"
                  | "ruleset_not_found";
              message: string;
          };
      }
    • response: Response

    Returns RequestError<
        number,
        {
            error: {
                code: | "failed"
                | "request_cannot_be_parsed"
                | "secret_api_key_required"
                | "secret_api_key_not_found"
                | "public_api_key_required"
                | "public_api_key_not_found"
                | "subscription_not_active"
                | "wrong_region"
                | "feature_not_enabled"
                | "request_not_found"
                | "visitor_not_found"
                | "too_many_requests"
                | "state_not_ready"
                | "event_not_found"
                | "missing_module"
                | "payload_too_large"
                | "service_unavailable"
                | "ruleset_not_found";
                message: string;
            };
        },
    >

Staticunknown

Settings

Member Visibility

On This Page

Constructors
Properties
Methods