perfect-debounce

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 trailing and leading behavior

Usage

Install package:

# npm
npm install perfect-debounce

# yarn
yarn add perfect-debounce

# pnpm
pnpm add 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 (use npm i -g corepack for 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.

Changelog

v1.0.0

compare changes

🩹 Fixes

• pkg: Add types subpath export (#14)

📖 Documentation

• Use correct yarn command (#12)
• Update installation guide for pnpm (#13)

🏡 Chore

• Update renovate config (#11)
• Update repo (46bc53a)
• Eslint ignore coverage (17fe6cf)
• Lint tests (18fe26a)

❤️ Contributors

• Pooya Parsa (@pi0)
• Daniel Roe [e-mail]
• Levi (Nguyễn Lương Huy) (@huynl-96)
• Nozomu Ikuta [e-mail]
• François Risoud (@qnp)