p-debounce

Debounce promise-returning & async functions

Install

$ npm install p-debounce

Usage

1import pDebounce from 'p-debounce';
2
3const expensiveCall = async input => input;
4
5const debouncedFn = pDebounce(expensiveCall, 200);
6
7for (const number of [1, 2, 3]) {
8	console.log(await debouncedFn(number));
9}
10//=> 3
11//=> 3
12//=> 3

API

pDebounce(fn, wait, options?)

Returns a function that delays calling fn until after wait milliseconds have elapsed since the last time it was called.

fn

Type: Function

Promise-returning/async function to debounce.

wait

Type: number

Milliseconds to wait before calling fn.

options

Type: object

before

Type: boolean
Default: false

Call the fn on the leading edge of the timeout. Meaning immediately, instead of waiting for wait milliseconds.

pDebounce.promise(function_)

Execute function_ unless a previous call is still pending, in which case, return the pending promise. Useful, for example, to avoid processing extra button clicks if the previous one is not complete.

function_

Type: Function

Promise-returning/async function to debounce.

1import {setTimeout as delay} from 'timers/promises';
2import pDebounce from 'p-debounce';
3
4const expensiveCall = async value => {
5	await delay(200);
6	return value;
7}
8
9const debouncedFn = pDebounce.promise(expensiveCall);
10
11for (const number of [1, 2, 3]) {
12	console.log(await debouncedFn(number));
13}
14//=> 1
15//=> 2
16//=> 3

Related

• p-throttle - Throttle promise-returning & async functions
• p-limit - Run multiple promise-returning & async functions with limited concurrency
• p-memoize - Memoize promise-returning & async functions
• debounce-fn - Debounce a function
• More…