Defined in: throttler.ts:54

Options for configuring a throttled function

• TFn extends AnyFunction

optional enabled: boolean | (throttler) => boolean;

optional enabled: boolean | (throttler) => boolean;

Defined in: throttler.ts:60

Whether the throttler is enabled. When disabled, maybeExecute will not trigger any executions. Can be a boolean or a function that returns a boolean. Defaults to true.

optional initialState: Partial<ThrottlerState<TFn>>;

optional initialState: Partial<ThrottlerState<TFn>>;

Defined in: throttler.ts:64

Initial state for the throttler

optional key: string;

optional key: string;

Defined in: throttler.ts:69

A key to identify the throttler. If provided, the throttler will be identified by this key in the devtools and PacerProvider if applicable.

optional leading: boolean;

optional leading: boolean;

Defined in: throttler.ts:74

Whether to execute on the leading edge of the timeout. Defaults to true.

optional onExecute: (args, throttler) => void;

optional onExecute: (args, throttler) => void;

Defined in: throttler.ts:78

Callback function that is called after the function is executed

Parameters<TFn>

Throttler<TFn>

void

optional trailing: boolean;

optional trailing: boolean;

Defined in: throttler.ts:83

Whether to execute on the trailing edge of the timeout. Defaults to true.

wait: number | (throttler) => number;

wait: number | (throttler) => number;

Defined in: throttler.ts:89

Time window in milliseconds during which the function can only be executed once. Can be a number or a function that returns a number. Defaults to 0ms