Null Pointer Micromanagement
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    throatpublic

    throat

    Throttle the parallelism of an asynchronous, promise returning, function / functions. This has special utility when you set the concurrency to 1. That way you get a mutually exclusive lock.

    Build Status Coverage Status Dependency Status NPM version Greenkeeper badge

    Sauce Test Status

    Installation

    npm install throat
    

    API

    throat(concurrency)

    This returns a function that acts a bit like a lock (exactly as a lock if concurrency is 1).

    Example, only 2 of the following functions will execute at any one time:

    const throat = require('throat')(2);
    // alternatively provide your own promise implementation 
    const throat = require('throat')(require('promise'))(2);
    const promise = Promise.resolve();
     
    const resA = throat(() => /* async stuff... */ promise);
    const resB = throat(() => /* async stuff... */ promise);
    const resC = throat(() => /* async stuff... */ promise);
    const resD = throat(() => /* async stuff... */ promise);
    const resE = throat(() => /* async stuff... */ promise);

    throat(concurrency, worker)

    This returns a function that is an exact copy of worker except that it will only execute up to concurrency times in parallel before further requests are queued:

    const throat = require('throat');
    // alternatively provide your own promise implementation 
    const throat = require('throat')(require('promise'));
     
    const input = ['fileA.txt', 'fileB.txt', 'fileC.txt', 'fileD.txt'];
    const data = Promise.all(input.map(throat(2, fileName => readFile(fileName))));

    Only 2 files will be read at a time, sometimes limiting parallelism in this way can improve scalability.

    License

    MIT

    install

    npm i throat

    Downloadsweekly downloads

    1,441,521

    version

    4.1.0

    license

    MIT

    repository

    github.com

    last publish

    collaborators

    • avatar