Home > @opengovsg/rate-limit > LocalRateLimiter
LocalRateLimiter interface
A rate limiter keyed by actor and resource, for identified traffic. Obtain one via createLocalRateLimiter().
Signature:
export interface LocalRateLimiterMethods
| Method | Description |
|---|---|
| check(args) | Consume from the allowance of
Pass a request-scoped Throws RateLimitExceededError when the allowance is exhausted. |