Skip to content

Home > @opengovsg/rate-limit > RateLimitConfig > burst

RateLimitConfig.burst property ​

Burst window layered on top of the steady window. Omit to inherit the limiter's default burst. Pass null to disable bursting entirely.

Disabled during a Redis outage, and when no client is configured.

Signature:

typescript
burst?: BurstConfig | null;