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// The following options are supported:
7// `leading`: whether the function should be called when the timeout is created, defaults to `false`
8// `trailing`: whether the function should be called when the timeout expires, defaults to `true`
9// `maxWait`: the maximum amount of time that can pass before the function is called, defaults to `Infinity`
10
11const debounced = debounce ( fn, 1000, {
12  leading: false,
13  trailing: true,
14  maxWait: Infinity
15});
16
17debounced (); // Schedule function for execution
18debounced (); // Re-schedule function for execution
19
20debounced.flush (); // Execute the function immediately, if there's a scheduled execution
21debounced.cancel (); // Cancel the scheduled execution
22
23// Throttling
24// The API for throttling is basically the same, except that:
25// - `leading`: is `true` by default rather than `false`
26// - `maxWait`: is set implicitly for you to be equal to the wait time
27
28const throttled = throttle ( fn, 1000, {
29  leading: true,
30  trailing: true
31});
32
33throttled (); // Call the function immediately
34throttled (); // Schedule function for execution
35
36throttled.flush (); // Execute the function immediately, if there's a scheduled execution
37throttled.cancel (); // Cancel the scheduled execution

License

MIT © Fabio Spampinato