Defined in: debouncer.ts:57

A class that creates a debounced function.

Debouncing ensures that a function is only executed after a certain amount of time has passed since its last invocation. This is useful for handling frequent events like window resizing, scroll events, or input changes where you want to limit the rate of execution.

The debounced function can be configured to execute either at the start of the delay period (leading edge) or at the end (trailing edge, default). Each new call during the wait period will reset the timer.

const debouncer = new Debouncer((value: string) => {
  saveToDatabase(value);
}, { wait: 500 });

// Will only save after 500ms of no new input
inputElement.addEventListener('input', () => {
  debouncer.maybeExecute(inputElement.value);
});

const debouncer = new Debouncer((value: string) => {
  saveToDatabase(value);
}, { wait: 500 });

// Will only save after 500ms of no new input
inputElement.addEventListener('input', () => {
  debouncer.maybeExecute(inputElement.value);
});

• TFn extends (...args) => any

• TArgs extends Parameters<TFn>

new Debouncer<TFn, TArgs>(fn, initialOptions): Debouncer<TFn, TArgs>

new Debouncer<TFn, TArgs>(fn, initialOptions): Debouncer<TFn, TArgs>

Defined in: debouncer.ts:66

TFn

DebouncerOptions

Debouncer<TFn, TArgs>

cancel(): void

cancel(): void

Defined in: debouncer.ts:130

Cancels any pending execution

void

getExecutionCount(): number

getExecutionCount(): number

Defined in: debouncer.ts:93

Returns the number of times the function has been executed

number

maybeExecute(...args): void

maybeExecute(...args): void

Defined in: debouncer.ts:101

Attempts to execute the debounced function If a call is already in progress, it will be queued

...TArgs

void

setOptions(newOptions): Required<DebouncerOptions>

setOptions(newOptions): Required<DebouncerOptions>

Defined in: debouncer.ts:80

Updates the debouncer options Returns the new options state

Partial<DebouncerOptions>

Required<DebouncerOptions>