Dettle

A tiny fully-featured debounce and throttle implementation.

Install

1npm install --save dettle

Usage

1import {debounce, throttle} from 'dettle';
2
3const fn = () => console.log ( 'Fired!' );
4
5// Debouncing
6
7const debounced = debounce ( fn, 1000, {
8  leading: false,
9  maxWait: 3000
10});
11
12debounced (); // Schedule function for execution
13debounced (); // Re-schedule function for execution
14
15debounced.flush (); // Execute the function immediately, if there's a scheduled execution
16debounced.cancel (); // Cancel the scheduled execution
17
18// Throttling
19// The API for throttling is basically the same, except that:
20// - `maxWait` is set implicitly for you to be equal to the wait time
21// - `leading` is `true` by default rather than `false`
22
23const throttled = throttle ( fn, 1000 );
24
25throttled (); // Call the function immediately
26throttled (); // Schedule function for execution
27
28throttled.flush (); // Execute the function immediately, if there's a scheduled execution
29throttled.cancel (); // Cancel the scheduled execution

License

MIT © Fabio Spampinato