perfect-debounce
An improved debounce function with Promise support.
- Well tested debounce implementation
- Native Promise support
- Avoid duplicate calls while promise is being resolved
- Configurable
trailingandleadingbehavior
Usage
Install package:
# npm
npm install perfect-debounce
# yarn
yarn install perfect-debounce
# pnpm
pnpm install perfect-debounce
Import:
// ESM
import { debounce } from 'perfect-debounce'
// CommonJS
const { debounce } = require('perfect-debounce')
Debounce function:
const debounced = debounce(async () => {
// Some heavy stuff
}, 25)
When calling debounced, it will wait at least for 25ms as configured before actually calling our function. This helps to avoid multiple calls.
To avoid initial wait, we can set leading: true option. It will cause function to be immediately called if there is no other call:
const debounced = debounce(async () => {
// Some heavy stuff
}, 25, { leading: true })
If executing async function takes longer than debounce value, duplicate calls will be still prevented a last call will happen. To disable this behavior, we can set trailing: false option:
const debounced = debounce(async () => {
// Some heavy stuff
}, 25, { trailing: false })
π»
Development
- Clone this repository
- Enable Corepack using
corepack enable(usenpm i -g corepackfor Node.js < 16.10) - Install dependencies using
pnpm install - Run interactive tests using
pnpm dev
License
Made with
Based on sindresorhus/p-debounce.
Published under MIT License.
3 Mar 21, 2022
8 Jun 7, 2022
1 Mar 26, 2022
96 Dec 20, 2022
5 May 20, 2022
11 Aug 15, 2022
172 Dec 29, 2022
65 Dec 26, 2022
23 Nov 29, 2022
8 Dec 5, 2022
9 Oct 8, 2022
98k Jan 5, 2023
14 Jun 14, 2022
25 Sep 11, 2022
21 Dec 15, 2022
4 Oct 18, 2022
19 Apr 8, 2022
299 Dec 8, 2022
2 Feb 17, 2022