JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 14167
  • Score
    100M100P100Q148640F
  • License Apache-2.0

Debouncing and throttling events module from Glize library.

Package Exports

  • debouncing

Readme

Debouncing Tweet

Build Status License NPM version Website NPM downloads

Debouncing and throttling events module from Glize library.

Usage

npm install debouncing --save
import {debounce, throttle} from 'debouncing';

const onResize = (event) => {
  console.log('height', window.innerHeight);
  console.log('width', window.innerWidth);
};

/**
 * In the debouncing technique, no matter how many times the user fires the 
 * event, the attached function will be executed only after the specified 
 * time once the user stops firing the event.
 * 
 * Returns a function, that, as long as it continues to be invoked, will not
 * be triggered. The function will be called after it stops being called for
 * N milliseconds.
 * @param {!Function} func The function to execute.
 * @param {number=} timeout The timeout in milliseconds.
 * @return {!Function} Returns a function, that, as long as it continues 
 *     to be invoked, will not be triggered.
 */
window.addEventListener('resize', debounce(onResize, 250), false);

/**
 * Throttling is a technique in which, no matter how many times the user 
 * fires the event, the attached function will be executed only once in a 
 * given time interval.
 * 
 * Returns a function, that, as long as it continues to be invoked, will only
 * trigger every N milliseconds.
 * @param {!Function} func The function to execute.
 * @param {number=} timeout The timeout in milliseconds.
 * @return {!Function} Returns a function, that, as long as it continues 
 *     to be invoked, will only trigger every N milliseconds.
 */
window.addEventListener('resize', throttle(onResize, 250), false);

For more information please visit Glize project page.