Interface RateLimitState

The shape of the rate limit state managed by the context.

export interface RateLimitState {
  isRateLimited: boolean;
  retryAfter: number | null;
  message: string | null;
}

interface RateLimitState {
    isRateLimited: boolean;
    retryAfter: null | number;
    message: null | string;
}

Properties

isRateLimited: boolean

Whether the API is currently rate limited.

retryAfter: null | number

The timestamp (ms) when requests can be retried, or null.

message: null | string

The message to display to the user, or null.