Skip to content

Home > @opengovsg/rate-limit > BurstConfig

BurstConfig interface ​

A short-lived allowance layered on top of the steady window to absorb legitimate spikes, such as a page load firing several parallel API calls.

Signature:

typescript
export interface BurstConfig

Properties ​

PropertyModifiersTypeDescription
durationnumberBurst window in seconds.
pointsnumberConsumption points available per burst window.