Home > @opengovsg/rate-limit > RateLimitInfo
RateLimitInfo interface
A snapshot of a key's rate-limit state after a check.
Signature:
typescript
export interface RateLimitInfoProperties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| isFirstInWindow | boolean | Whether this check opened a new window. | |
| msToNextWindow | number | Milliseconds until the current window resets. | |
| points | { remaining: number; consumed: number; } | Point usage in the current window. |