debounce<F extends (...args: any[]) => any>(): DebouncedFunction<F>
Creates a debounced function that delays invoking the provided function until after debounceMs milliseconds
have elapsed since the last time the debounced function was invoked. The debounced function also has a cancel
method to cancel any pending execution.
You can set the debounced function to run at the start (leading) or end (trailing) of the delay period.
If leading is true, the function runs immediately on the first call.
If trailing is true, the function runs after debounceMs milliseconds have passed since the last call.
If both leading and trailing are true, the function runs at both the start and end, but it must be called at least twice within debounceMs milliseconds for this to happen
(since one debounced function call cannot trigger the function twice).
You can also set a maxWait time, which is the maximum time the function is allowed to be delayed before it is called.
const debouncedFunction = debounce(() => {
console.log('Function executed');
}, 1000);
const debouncedFunction = debounce(() => { console.log('Function executed'); }, 1000);
// Will log 'Function executed' after 1 second if not called again in that time debouncedFunction();
// Will not log anything as the previous call is canceled debouncedFunction.cancel();
// With AbortSignal const controller = new AbortController(); const signal = controller.signal; const debouncedWithSignal = debounce(() => { console.log('Function executed'); }, 1000, { signal });
debouncedWithSignal();
// Will cancel the debounced function call controller.abort();
A new debounced function with a cancel method.