Interface: DebouncedFunction()<T>

A debounced wrapper around a function T with helper methods.

Remarks

The callable signature applies debounce timing; DebouncedFunction.clear cancels a pending invocation and DebouncedFunction.flush forces it to run now.

const onResize = debounce(() => layout(), 150);
window.addEventListener("resize", onResize);
onResize.clear(); // cancel pending call

T extends (...args) => any

The original function type being debounced.

DebouncedFunction(...args): ReturnType<T>

Invokes the debounced function, applying debounce timing rules.

...Parameters<T>

Arguments forwarded to the original function T.

ReturnType<T>

Return value of the last immediate invocation, or undefined if the call was deferred / never invoked.

clear(): void

Cancels any pending (not yet fired) invocation.

void

const fn = debounce(save, 300);
fn(); fn.clear(); // save will not run

flush(): ReturnType<T>

Immediately invokes the pending debounced call (if any) and returns its result.

ReturnType<T>

Return value of the flushed invocation, or the last invocation's return value if nothing was pending, or undefined if never invoked.

const fn = debounce(save, 300);
fn(); fn.flush(); // save runs now instead of after 300 ms