limited-calls

Wraps a function so it will only be called once during a set delay time.

--

I wrote this to limit the amount of calls to an event handler to a maximum of 1 call every 100 milliseconds.

Usage:

Install with npm: npm install --save limited-calls

const limitedCalls = require('limited-calls');

// a trivial custom logger to be used in the example
const show = (...text) => console.log('showing:', ...text);

// wrap the show function, allowing only calling once a second
const limitedShow = limitedCalls(show, 1000);

limitedShow('hello', 'world!');
limitedShow('ignored', 'not showing..');
limitedShow('ignored', 'not showing..');
limitedShow('last pending call only shows', 'if 3d argument to limitedCalls is a falsey');
// showing: hello world!
// showing: last pending call only shows if 3d argument to limitedCalls is a falsey

// when calls to the function are made during the delay time,
// the last call is saved and called directly after the delay expires.
// if you want to also ignore this last pending call then you can
// pass true as a third parameter to set "ignorePending"
const limitedShowIgnorePending = limitedCalls(show, 1000, true);

license

MIT