Interfacetypesv0.8.0-next.6

RateLimitResult

The outcome of an IRateLimiterIRateLimiter chargecharge or peekpeek.

interface RateLimitResult

interface RateLimitResult

Properties

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

limited: boolean;

limited: boolean;

Slots left in the current window. Exact after a chargecharge, advisory on a peekpeek.

remaining: number;

remaining: number;

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

resetAt: EpochMs;

resetAt: EpochMs;

Milliseconds until resetAtresetAt. 00 when not limited.

retryAfterMs: number;

retryAfterMs: number;