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

Options for configuring an async rate-limited function

• TFn extends AnyAsyncFunction

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, rateLimiter) => void;

optional onError: (error, rateLimiter) => void;

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

Optional error handler for when the rate-limited function throws

unknown

AsyncRateLimiter<TFn>

void

optional onReject: (rateLimiter) => void;

optional onReject: (rateLimiter) => void;

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

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

AsyncRateLimiter<TFn>

void

optional onSettled: (rateLimiter) => void;

optional onSettled: (rateLimiter) => void;

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

Optional function to call when the rate-limited function is executed

AsyncRateLimiter<TFn>

void

optional onSuccess: (result, rateLimiter) => void;

optional onSuccess: (result, rateLimiter) => void;

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

Optional function to call when the rate-limited function is executed

ReturnType<TFn>

AsyncRateLimiter<TFn>

void

window: number;

window: number;

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

Time window in milliseconds within which the limit applies