Package Exports

throttle-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 (throttle-debounce) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

throttle-debounce

Throttle/debounce your functions.

This module is the same as jquery-throttle-debounce, but it’s transferred to CommonJS so it can be easily used with tools like Browserify, RequireJS or Webpack without polluting global namespace.

For convenience, standalone version is also provided and it maps to jQuery namespace if it exists, otherwise it adds two methods to global (window) namespace.

Throttle/debounce allows you to rate-limit your functions in multiple useful ways. Passing a delay and callback to throttle returns a new function that will execute no more than once every delay milliseconds. Passing a delay and callback to debounce returns a new function that will execute only once, coalescing multiple sequential calls into a single execution at either the very beginning or end.

Installation

npm install throttle-debounce --save

bower install throttle-debounce --save

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.

Examples

var td = require('throttle-debounce');
td.throttle(300, function () {
    // Throttled function
});
td.debounce(300, function () {
    // Debounced function
});

AMD and global

define(['throttle-debounce'], cb);

window.$.throttle; // if there is no $, then use `window.throttle`
window.$.debounce; // if there is no $, then use `window.debounce`

Browser support

Tested in IE8+ and all modern browsers.