Interface RateLimiterKeyState

Read-only snapshot of a key's live limiter state — for tests, metrics, and debugging.

interface RateLimiterKeyState {
    Burst: number;
    EffectiveTokensPerSec: number;
    FrozenUntil: number;
    Tokens: number;
}

Properties

Burst: number

Bucket capacity (burst).

EffectiveTokensPerSec: number

Current effective refill rate in tokens/sec (between MinTokensPerSec and TokensPerSec).

FrozenUntil: number

Epoch ms until which refills are frozen by a Retry-After (0 = not frozen).

Tokens: number

Current available tokens (fractional).