function debounce<TFn>(fn, initialOptions): (...args) => void

function debounce<TFn>(fn, initialOptions): (...args) => void

Defined in: debouncer.ts:158

Creates a debounced function that delays invoking the provided function until after a specified wait time. Multiple calls during the wait period will cancel previous pending invocations and reset the timer.

This the the simple function wrapper implementation pulled from the Debouncer class. If you need more control over the debouncing behavior, use the Debouncer class directly.

If leading option is true, the function will execute immediately on the first call, then wait the delay before allowing another execution.

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

TFn

Omit<DebouncerOptions, "enabled">

Function

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

...Parameters

void

const debounced = debounce(() => {
  saveChanges();
}, { wait: 1000 });

// Called repeatedly but executes at most once per second
inputElement.addEventListener('input', debounced);

const debounced = debounce(() => {
  saveChanges();
}, { wait: 1000 });

// Called repeatedly but executes at most once per second
inputElement.addEventListener('input', debounced);