DebouncerOptions

Defined in: debouncer.ts:49

Options for configuring a debounced function

Type Parameters#

TFn#

TFn extends AnyFunction

Properties#

enabled?#

optional enabled?: boolean | ((debouncer) => boolean);

Defined in: debouncer.ts:55

Whether the debouncer 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<DebouncerState<TFn>>;

Defined in: debouncer.ts:59

Initial state for the debouncer

key?#

optional key?: string;

Defined in: debouncer.ts:64

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

leading?#

optional leading?: boolean;

Defined in: debouncer.ts:70

Whether to execute on the leading edge of the timeout. The first call will execute immediately and the rest will wait the delay. Defaults to false.

onExecute?#

optional onExecute?: (args, debouncer) => void;

Defined in: debouncer.ts:74

Callback function that is called after the function is executed

Parameters#

args#

Parameters<TFn>

debouncer#

Debouncer<TFn>

Returns#

void

trailing?#

optional trailing?: boolean;

Defined in: debouncer.ts:79

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

wait#

wait: number | ((debouncer) => number);

Defined in: debouncer.ts:85

Delay in milliseconds before executing the function. Can be a number or a function that returns a number. Defaults to 0ms