Class RateLimitError

Represents a rate limiting error (429 Too Many Requests). Contains information about retry timing if available.

Hierarchy (View Summary)

ApiError
- RateLimitError

Index

Constructors

Properties

response body retryAfter? resetTime?

Methods

getRetryDelayMs canRetryNow

Constructors

constructor

new RateLimitError(response: Response, body: unknown): RateLimitError
Parameters
- response: Response
- body: unknown
Returns RateLimitError
Overrides ApiError.constructor
- Defined in core/errors.ts:44

Properties

`Readonly`response

response: null | Response

`Readonly`body

body: unknown

`Optional` `Readonly`retryAfter

retryAfter?: number

`Optional` `Readonly`resetTime

resetTime?: Date

Methods

getRetryDelayMs

getRetryDelayMs(): number
Get the recommended delay in milliseconds before retrying

Returns number
- Defined in core/errors.ts:64

canRetryNow

canRetryNow(): boolean
Check if enough time has passed since the rate limit was hit to retry

Returns boolean
- Defined in core/errors.ts:75