Class RateLimitError

Thrown for HTTP 429 responses or when the client-side rate limiter trips. retryAfter is the suggested wait in milliseconds, when known.

Hierarchy (View Summary)

BugBugError
- RateLimitError

Index

Constructors

Properties

code statusCode response? request? cause? retryAfter?

Methods

Constructors

constructor

new RateLimitError(
    retryAfter?: number,
    message?: string,
    response?: Response,
    request?: RequestOrigin,
): RateLimitError
Parameters
- OptionalretryAfter: number
- message: string = 'Rate limit exceeded'
- Optionalresponse: Response
- Optionalrequest: RequestOrigin
Returns RateLimitError
Overrides BugBugError.constructor
- Defined in sdk/src/types/errors.ts:229

Properties

`Readonly`code

code: SdkErrorCode

`Readonly`statusCode

statusCode: number

`Optional` `Readonly`response

response?: Response

`Optional` `Readonly`request

request?: RequestOrigin

`Optional` `Readonly`cause

cause?: Error

`Optional` `Readonly`retryAfter

retryAfter?: number

Methods

toJSON

toJSON(): {
    name: string;
    code: SdkErrorCode;
    message: string;
    statusCode: number;
    request: RequestOrigin
    | undefined;
    stack: string | undefined;
}
Returns {
    name: string;
    code: SdkErrorCode;
    message: string;
    statusCode: number;
    request: RequestOrigin | undefined;
    stack: string | undefined;
}
Inherited from BugBugError.toJSON
- Defined in sdk/src/types/errors.ts:68