Skip to content
Interfacetypesv0.14.4

RateLimitResult

The outcome of an IRateLimiter charge or peek.

interface RateLimitResult

limited

Whether the key is at or over its limit for the current window.

limited: boolean;

remaining

Slots left in the current window. Exact after a charge, advisory on a peek.

remaining: number;

resetAt

Absolute epoch milliseconds when the earliest slot frees up, for <t:...:R> markup after a divide by 1000. 0 when not limited.

resetAt: EpochMs;

retryAfterMs

Milliseconds until resetAt. 0 when not limited.

retryAfterMs: number;