Interface RateLimitResult

interface RateLimitResult {
    limited: boolean;
    remaining: number;
    retryAfterMs: number;
}

Properties

limited: boolean

true ⇒ this request is OVER the budget and must be rejected.

remaining: number

requests remaining in the window after this one (≥ 0).

retryAfterMs: number

ms until the window resets — drives Retry-After. 0 when not limited.