Class RateLimitError

Hierarchy

Error
- RateLimitError

Index

Constructors

Properties

status rateLimitRemaining retryAfterSeconds errors cause? name message stack?

Methods

Constructors

constructor

new RateLimitError(
    options?: {
        rateLimitRemaining?: number | null;
        retryAfterSeconds?: number;
        errors?: UpErrorObject[];
    },
): RateLimitError
Parameters
- Optionaloptions: {
      rateLimitRemaining?: number | null;
      retryAfterSeconds?: number;
      errors?: UpErrorObject[];
  }
Returns RateLimitError
Overrides Error.constructor
- Defined in packages/up-api/src/errors/index.ts:21

Properties

`Readonly`status

status: 429

`Readonly`rateLimitRemaining

rateLimitRemaining: number | null

`Readonly`retryAfterSeconds

retryAfterSeconds: number

`Readonly`errors

errors: UpErrorObject[]

`Optional`cause

cause?: unknown

name

name: string

message

message: string

`Optional`stack

stack?: string

Methods

`Static`isError

isError(error: unknown): error is Error
Indicates whether the argument provided is a built-in Error instance or not.
Parameters
- error: unknown
Returns error is Error
Inherited from Error.isError
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.esnext.error.d.ts:23