README

BlockIt

Promises are a great addition to JavaScript, but if you're creating a lot of requests to a rate limited or fragile API, you need some throttling not offered out of the box by Promises.

BlockIt offers ways of throttling Promises, either through executing your tasks 1 by 1 blocking style or setting a timeout in between execution of tasks.

All functions return a Promise, and results are stored in an array that is resolved when all array items have been passed to the callback.

blockIt guarantees order of results in the resolved array will correspond to the provided input array, while stallIt and paceIt append to the array as their Promises resolve.

Usage

Import

const blockIt = require('blockIt').blockIt;
const stallIt = require('blockIt').stallIt;
const paceIt = require('blockIt').paceIt;

blockIt

Each array item is passed into awesomeFunction synchronously, the next item doesn't execute until the previous resolves.

const awesomeFunction = () => Promise.resolve();
const awesomeArr = ['first', 'second'];

blockIt(awesomeFunction, awesomeArr)
    .then((result) => {
        // Do something awesome with your result
    });

stallIt

A provided interval is used as a buffer between function executions.

// Pass the next array item into the function every half-second
stallIt(awesomeFunction, awesomeArr, 500)
    .then((result) => {
        // Do more awesome stuff with your result
    });

paceIt

Similar to stallIt, but instead of an interval, pass in the desired amount of executions to allow per second. Useful for rate limited API's.

// perform 20 awesomeFunctions a second
paceIt(awesomeFunction, awesomeArr, 20)
    .then((result) => {
        // Fickle API limits? Have no fear!
    });

blockit

Usage no npm install needed!