maybedone v0.0.2

maybedone

Small Node.js helper to wrap callbacks and only call those underlying callback after X times or a predicate function returns true.

install

npm install --save maybedone

usage

const md = maybedone(cb, predicateFn|times);

cb: underlying callback

predicateFn: a function that must return true before cb is called

times: number of times md must be called before the callback is called

When called with an error, md will immediately call the callback with the error.

md will always at most call a callback once.

md does not throw errors even if it is called too many times.

Examples

import maybedone from 'maybedone';
// var maybedone = require('maybedone');

const cb = () => { console.log('done'); };

const md = maybedone(cb, () => {
  return Math.random() > 0.5;
});
// var md = maybdone(cb, function() { /.../ });

md();
md();
md();

import maybedone from 'maybedone';

const cb = () => { console.log('done'); };

const md = maybedone(cb, 3);

md();
md();
md();
// callback fires here
md();
md();
md();

import maybedone from 'maybedone';

const cb = () => { console.log('done'); };

const md = maybedone(cb, 3);

md();
md('someerror');
// callback fires here with error