Interface RateLimiterOptions

Configuration for a RateLimiter.

interface RateLimiterOptions {
    capacity: number;
    clock?: Clock;
    onEvent?: EventSink;
    onExhausted?: "wait" | "reject";
    perSecond: number;
}

Index

Properties

capacity clock? onEvent? onExhausted? perSecond

Properties

`Readonly`capacity

capacity: number

Bucket size, which is the largest burst allowed after an idle period.

`Optional` `Readonly`clock

clock?: Clock

Defaults to the system clock.

`Optional` `Readonly`onEvent

onEvent?: EventSink

Receives a rate-limited event whenever a call finds the bucket empty.

`Optional` `Readonly`onExhausted

onExhausted?: "wait" | "reject"

What to do when the bucket is empty: wait for a token, or refuse the call with a RateLimitError. Defaults to "wait".

`Readonly`perSecond

perSecond: number

Tokens added per second.