JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 9994077
  • Score
    100M100P100Q207377F
  • License MIT

Creates and returns a new debounced version of the passed function that will postpone its execution until after wait milliseconds have elapsed since the last time it was invoked

Package Exports

  • debounce

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (debounce) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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);

(You can also use const debounce = require('debounce'))

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();

To execute immediately only if you have scheduled invocations 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.
  • p-debounce - Similar but handles promises
  • throttleit - Throttle a function to limit its execution rate