Home > @opengovsg/rate-limit > RateLimiter
RateLimiter interface
A rate limiter. Obtain one via createRateLimiter(), createGlobalRateLimiter() or createLocalRateLimiter().
Signature:
typescript
export interface RateLimiterMethods
| Method | Description |
|---|---|
| check(args) | Consume one point from Resolves with a RateLimitInfo snapshot when within limits. Throws RateLimitExceededError when the allowance is exhausted. Any other error is reported via Pass a request-scoped |