jaz303 / promise-debounce

Debounce any promise-returning function so that at any instant only one call is pending
MIT License
5 stars 1 forks source link

promise-debounce

Installation

npm

Get it:

npm install promise-debounce

Require it:

var debounce = require('promise-debounce');

Example

var getStatus = debounce(ajax.bind(null, "GET", "/status.json"));

// The three following calls will cause only a single AJAX request...

getStatus().then(function(status) {
    // ...
}); 

getStatus().then(function(status) {
    // ...
});

getStatus().then(function(status) {
    // ...
});

API

var debounced = debounce(fn, [ctx])

Returns a debounced version of fn with optional calling context ctx.

fn must be a function which returns a promise.

If debounced is called and no other call is currently pending, fn will be called and its promise returned. Otherwise - if another call is pending - the original promise will be returned.