Skip to content

Home > @opengovsg/rate-limit > createLocalRateLimiter

createLocalRateLimiter() function ​

Create a rate limiter enforcing per-actor, per-resource quotas for identified traffic.

Defaults to 50 points per 10 seconds with a burst of 20 per 30 seconds. Override via CreateRateLimiterOptions.overrides.

Signature:

typescript
createLocalRateLimiter: (options: CreateLocalRateLimiterOptions) => LocalRateLimiter

Parameters ​

ParameterTypeDescription
optionsCreateLocalRateLimiterOptions

Returns:

LocalRateLimiter