throttle - nodef/extra-function GitHub Wiki

Generate throttled version of a function.

Alternatives: throttle, throttleEarly. Similar: throttle, debounce.

function throttle(x, t)
// x: a function
// t: wait time (ms)
const xfunction = require('extra-function');


var count = 0;
var fn = xfunction.throttle(() => ++count, 2500);
setTimeout(fn, 0);
setTimeout(fn, 1000);
setTimeout(fn, 2000);
// `count` incremented after 2.5s


var count = 0;
var fn = xfunction.throttle(() => ++count, 2500);
setTimeout(fn, 0);
setTimeout(fn, 1000);
setTimeout(fn, 2000);
setTimeout(fn, 3000);
setTimeout(fn, 4000);
// `count` incremented after 2.5s
// `count` incremented after 5.5s

References