Interface RateLimitContextType

The shape of the rate limit context value provided to consumers.

Source

interface RateLimitContextType {
  rateLimitState: RateLimitState;
  setRateLimit: (
    isLimited: boolean,
    retryTime?: number,
    message?: string,
  ) => void;
  clearRateLimit: () => void;
}
interface RateLimitContextType {
    rateLimitState: RateLimitState;
    setRateLimit: (
        isLimited: boolean,
        retryTime?: number,
        message?: string,
    ) => void;
    clearRateLimit: () => void;
}

Properties

rateLimitState setRateLimit clearRateLimit

Properties

rateLimitState

rateLimitState: RateLimitState

The current rate limit state.

setRateLimit

setRateLimit: (isLimited: boolean, retryTime?: number, message?: string) => void

Function to set the rate limit state.

clearRateLimit

clearRateLimit: () => void

Function to clear the rate limit state.

Settings

Member Visibility

On This Page

Properties