Wondering what’s next for npm?Check out our public roadmap! »

    throat
    TypeScript icon, indicating that this package has built-in type declarations

    6.0.1 • Public • Published

    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.

    Professionally supported throat is now available

    Build Status Coveralls github branch Rolling Versions NPM version

    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);
    
    const resA = throat(async () => { /* async stuff... */ });
    const resB = throat(async () => { /* async stuff... */ });
    const resC = throat(async () => { /* async stuff... */ });
    const resD = throat(async () => { /* async stuff... */ });
    const resE = throat(async () => { /* async stuff... */ });

    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');
    
    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.

    Security contact information

    To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

    License

    MIT

    Install

    npm i throat

    DownloadsWeekly Downloads

    12,164,984

    Version

    6.0.1

    License

    MIT

    Unpacked Size

    9.16 kB

    Total Files

    6

    Last publish

    Collaborators

    • avatar
    • avatar