Skip to content

Home > @opengovsg/rate-limit > RateLimitInfo

RateLimitInfo interface ​

A snapshot of a key's rate-limit state after a check.

Signature:

typescript
export interface RateLimitInfo

Properties ​

PropertyModifiersTypeDescription
isFirstInWindowbooleanWhether this check opened a new window.
msToNextWindownumberMilliseconds until the current window resets.
points{ remaining: number; consumed: number; }Point usage in the current window.