debounce

debounce

Delay function calls until a set time elapses after the last invocation

Install

npm install debounce

Usage

import debounce from 'debounce';

function resize() {
	console.log('height', window.innerHeight);
	console.log('width', window.innerWidth);
}

window.onresize = debounce(resize, 200);

To check if the debounce delay is currently active:

window.onresize.isPending;

To later clear the timer and cancel currently scheduled executions:

window.onresize.clear();

Execute immediately only if a call is pending (and reset the timer):

window.onresize.flush();

To execute immediately and reset the timer if it was previously set:

window.onresize.trigger();

API

debounce(fn, wait, options?)

Creates a debounced function that delays execution until wait milliseconds have passed since its last invocation.

Set the immediate option to true to execute the function immediately at the start of the wait interval, preventing issues such as double-clicks on a button.

The returned function has the following methods:

• .isPending indicates whether the debounce delay is currently active.
• .clear() cancels any scheduled executions.
• .flush() if an execution is scheduled then it will be immediately executed and the timer will be cleared.
• .trigger() executes the function immediately and clears the timer if it was previously set.

Related

• p-debounce - Similar but handles promises
• throttleit - Throttle a function to limit its execution rate

Similar packages

Other packages similar to debounce

lodash.debounce

lodash.debounce is a function from the popular Lodash library that provides debouncing capabilities. It is similar to debounce but comes with additional options for leading and trailing invocation, and maxWait time. Lodash's debounce is often preferred for its extended functionality and reliability within the Lodash ecosystem.

throttle-debounce

throttle-debounce is a package that offers both throttle and debounce functions. While debounce delays function execution, throttle ensures that a function is only called at most once in a specified period. This package is useful for those who need both functionalities and prefer a combined solution.

p-debounce

p-debounce is a package that provides debouncing functionality for promises. It is similar to debounce but is specifically designed to work with functions that return promises, ensuring that a promise-returning function is not invoked too frequently.