Defined in: throttler.ts:54
Options for configuring a throttled function
Type Parameters#
TFn#
TFn extends AnyFunction
Properties#
enabled?#
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.
initialState?#
optional initialState?: Partial<ThrottlerState<TFn>>;
Defined in: throttler.ts:64
Initial state for the throttler
key?#
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.
leading?#
optional leading?: boolean;
Defined in: throttler.ts:74
Whether to execute on the leading edge of the timeout. Defaults to true.
onExecute?#
optional onExecute?: (args, throttler) => void;
Defined in: throttler.ts:78
Callback function that is called after the function is executed
Parameters#
args#
Parameters<TFn>
throttler#
Throttler<TFn>
Returns#
void
trailing?#
optional trailing?: boolean;
Defined in: throttler.ts:83
Whether to execute on the trailing edge of the timeout. Defaults to true.
wait#
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