Skip to content

Home > @opengovsg/rate-limit > CreateGlobalRateLimiterOptions

CreateGlobalRateLimiterOptions interface ​

Options for creating a global rate limiter.

Signature:

typescript
export interface CreateGlobalRateLimiterOptions extends CreateRateLimiterOptions

Extends: CreateRateLimiterOptions

Properties ​

PropertyModifiersTypeDescription
skipKeyNormalization?boolean

(Optional) Whether to skip normalizing IPs before using them as store keys. Defaults to false.

Set this to true only when the caller already supplies a trusted, canonical key, which is then used verbatim with no /64 bucketing and no unknown fallback for unparseable strings.