Defined in: async-rate-limiter.ts:6

Options for configuring an async rate-limited function

optional enabled: boolean;

optional enabled: boolean;

Defined in: async-rate-limiter.ts:11

Whether the rate limiter is enabled. When disabled, maybeExecute will not trigger any executions. Defaults to true.

limit: number;

limit: number;

Defined in: async-rate-limiter.ts:15

Maximum number of executions allowed within the time window

optional onError: (error) => void;

optional onError: (error) => void;

Defined in: async-rate-limiter.ts:27

Optional error handler for when the rate-limited function throws

unknown

void

optional onReject: (info) => void;

optional onReject: (info) => void;

Defined in: async-rate-limiter.ts:23

Optional callback function that is called when an execution is rejected due to rate limiting

RateLimitRejectionInfo

void

window: number;

window: number;

Defined in: async-rate-limiter.ts:19

Time window in milliseconds within which the limit applies