Class RequestError<Code, Body>

Type Parameters

Code extends number = number
Body = unknown

Hierarchy (View Summary)

SdkError
- RequestError
  - TooManyRequestsError

Index

Constructors

Properties

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

Methods

captureStackTrace fromErrorResponse unknown

Constructors

constructor

new RequestError<Code extends number = number, Body = unknown>(
    message: string,
    body: Body,
    statusCode: Code,
    errorCode: string,
    response: Response,
): RequestError<Code, Body>
Type Parameters
- Code extends number = number
- Body = unknown
Parameters
- message: string
- body: Body
- statusCode: Code
- errorCode: string
- response: Response
Returns RequestError<Code, Body>
Overrides SdkError.constructor
- Defined in src/errors/apiErrors.ts:27

Properties

`Optional`cause

cause?: unknown

`Readonly`errorCode

errorCode: string

message

message: string

name

name: string

`Readonly`response

response: Response

`Readonly`responseBody

responseBody: Body

`Optional`stack

stack?: string

`Readonly`statusCode

statusCode: Code

`Static` `Optional`prepareStackTrace

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

Optional override for formatting stack traces

See

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

`Static`stackTraceLimit

stackTraceLimit: number

Methods

`Static`captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void
Create .stack property on a target object
Parameters
- targetObject: object
- OptionalconstructorOpt: Function
Returns void
Inherited from SdkError.captureStackTrace
- Defined in node_modules/.pnpm/@types+node@20.11.30/node_modules/@types/node/globals.d.ts:21

`Static`fromErrorResponse

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;
        };
    },
>
- Defined in src/errors/apiErrors.ts:39

`Static`unknown

unknown(response: Response): RequestError<number, undefined>
Parameters
- response: Response
Returns RequestError<number, undefined>
- Defined in src/errors/apiErrors.ts:35