p-limit

  • Version 6.2.0
  • Published
  • 10.3 kB
  • 1 dependency
  • MIT license

Install

npm i p-limit
yarn add p-limit
pnpm add p-limit

Overview

Run multiple promise-returning & async functions with limited concurrency

Index

Functions

function limitFunction

limitFunction: <Arguments extends unknown[], ReturnType>(
function_: (...arguments_: Arguments) => PromiseLike<ReturnType> | ReturnType,
option: Options
) => (...arguments_: Arguments) => Promise<ReturnType>;
  • Returns a function with limited concurrency.

    The returned function manages its own concurrent executions, allowing you to call it multiple times without exceeding the specified concurrency limit.

    Ideal for scenarios where you need to control the number of simultaneous executions of a single function, rather than managing concurrency across multiple functions.

    Parameter function_

    Promise-returning/async function. Function with limited concurrency.

    Example 1

    import {limitFunction} from 'p-limit';
    const limitedFunction = limitFunction(async () => {
    return doSomething();
    }, {concurrency: 1});
    const input = Array.from({length: 10}, limitedFunction);
    // Only one promise is run at once.
    await Promise.all(input);

function pLimit

pLimit: (concurrency: number) => LimitFunction;
  • Run multiple promise-returning & async functions with limited concurrency.

    Parameter concurrency

    Concurrency limit. Minimum: 1.

    Returns

    A limit function.

Type Aliases

type LimitFunction

type LimitFunction = {
/**
The number of promises that are currently running.
*/
readonly activeCount: number;
/**
The number of promises that are waiting to run (i.e. their internal `fn` was not called yet).
*/
readonly pendingCount: number;
/**
Get or set the concurrency limit.
*/
concurrency: number;
/**
Discard pending promises that are waiting to run.
This might be useful if you want to teardown the queue at the end of your program's lifecycle or discard any function calls referencing an intermediary state of your app.
Note: This does not cancel promises that are already running.
*/
clearQueue: () => void;
/**
@param fn - Promise-returning/async function.
@param arguments - Any arguments to pass through to `fn`. Support for passing arguments on to the `fn` is provided in order to be able to avoid creating unnecessary closures. You probably don't need this optimization unless you're pushing a lot of functions.
@returns The promise returned by calling `fn(...arguments)`.
*/
<Arguments extends unknown[], ReturnType>(
function_: (
...arguments_: Arguments
) => PromiseLike<ReturnType> | ReturnType,
...arguments_: Arguments
): Promise<ReturnType>;
};

    type Options

    type Options = {
    /**
    Concurrency limit.
    Minimum: `1`.
    */
    readonly concurrency: number;
    };

      Package Files (1)

      Dependencies (1)

      Dev Dependencies (7)

      Peer Dependencies (0)

      No peer dependencies.

      Badge

      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/p-limit.

      • Markdown
        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/p-limit)
      • HTML
        <a href="https://www.jsdocs.io/package/p-limit"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>