Defined in: async-throttler.ts:6

Options for configuring an async throttled function

• TFn extends AnyAsyncFunction

• TArgs extends Parameters<TFn>

optional enabled: boolean;

optional enabled: boolean;

Defined in: async-throttler.ts:14

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

optional onError: (error) => void;

optional onError: (error) => void;

Defined in: async-throttler.ts:18

Optional error handler for when the throttled function throws

unknown

void

optional onExecute: (throttler) => void;

optional onExecute: (throttler) => void;

Defined in: async-throttler.ts:22

Optional function to call when the throttled function is executed

AsyncThrottler<TFn, TArgs>

void

wait: number;

wait: number;

Defined in: async-throttler.ts:27

Time window in milliseconds during which the function can only be executed once Defaults to 0ms