Throttle and debounce functions.
Switch branches/tags
Nothing to show
Clone or download
Latest commit f569676 Oct 24, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
test test-case for debounce.cancel Oct 24, 2018
.editorconfig Refactor May 1, 2016
.eslintrc Upgrade package Jun 8, 2018
.gitignore Upgrade package Jun 8, 2018
.rollup.js Upgrade package Jun 8, 2018
.travis.yml Upgrade package Jun 8, 2018
LICENSE.md Refactor May 1, 2016
README.md Feature/cancel with README (#25) Oct 24, 2018
debounce.js Upgrade to ES Modules Jun 8, 2018
index.js Upgrade to ES Modules Jun 8, 2018
karma.conf.js Upgrade package Jun 8, 2018
package.json 2.0.1 Jul 26, 2018
throttle.js Revert "Reuse existing cancel definition" Oct 24, 2018

README.md

throttle-debounce

Build Status Mentioned in Awesome Micro npm Packages

Throttle and debounce functions.

This module is the same as jquery-throttle-debounce (with some differences), but it’s transferred to ES Modules and CommonJS format.

Install

npm install throttle-debounce --save

Usage

import { throttle, debounce } from 'throttle-debounce';

throttle(300, function () {
	// Throttled function
});

debounce(300, function () {
	// Debounced function
});

API

throttle(delay, noTrailing, callback, debounceMode)

Returns: Function

Throttle execution of a function. Especially useful for rate limiting execution of handlers on events like resize and scroll.

delay

Type: Number

A zero-or-greater delay in milliseconds. For event callbacks, values around 100 or 250 (or even higher) are most useful.

noTrailing

Type: Boolean

Optional, defaults to false. If noTrailing is true, callback will only execute every delay milliseconds while the throttled-function is being called. If noTrailing is false or unspecified, callback will be executed one final time after the last throttled-function call. (After the throttled-function has not been called for delay milliseconds, the internal counter is reset)

callback

Type: Function

A function to be executed after delay milliseconds. The this context and all arguments are passed through, as-is, to callback when the throttled-function is executed.

debounceMode

Type: Boolean

If debounceMode is true (at begin), schedule clear to execute after delay ms. If debounceMode is false (at end), schedule callback to execute after delay ms.

debounce(delay, atBegin, callback)

Returns: Function

Debounce execution of a function. Debouncing, unlike throttling, guarantees that a function is only executed a single time, either at the very beginning of a series of calls, or at the very end.

delay

Type: Number

A zero-or-greater delay in milliseconds. For event callbacks, values around 100 or 250 (or even higher) are most useful.

atBegin

Type: Boolean

Optional, defaults to false. If atBegin is false or unspecified, callback will only be executed delay milliseconds after the last debounced-function call. If atBegin is true, callback will be executed only at the first debounced-function call. (After the throttled-function has not been called for delay milliseconds, the internal counter is reset).

callback

Type: Function

A function to be executed after delay milliseconds. The this context and all arguments are passed through, as-is, to callback when the debounced-function is executed.

Cancelling

throttle and debounce return functions that have a .cancel() method, which can be used to cancel any scheduled calls.

Differences with original module

  • Dependancy on jQuery is removed, so if you rely on GUIDs set by jQuery, plan accordingly
  • There is no standalone version available, so don’t rely on $.throttle and $.debounce to be available

Browser support

Tested in IE9+ and all modern browsers.

Test

For local automated tests, run npm run test:automated:local (append :watch for watcher support).

License

Original module license: Copyright (c) 2010 "Cowboy" Ben Alman (Dual licensed under the MIT and GPL licenses. http://benalman.com/about/license/)
This module license: MIT © Ivan Nikolić