p-limit

Run multiple promise-returning & async functions with limited concurrency

Works in Node.js and browsers.

Install

1npm install p-limit

Usage

1import pLimit from 'p-limit';
2
3const limit = pLimit(1);
4
5const input = [
6	limit(() => fetchSomething('foo')),
7	limit(() => fetchSomething('bar')),
8	limit(() => doSomething())
9];
10
11// Only one promise is run at once
12const result = await Promise.all(input);
13console.log(result);

API

pLimit(concurrency) ^{default export}

Returns a limit function.

concurrency

Type: number
Minimum: 1

Concurrency limit.

limit(fn, ...args)

Returns the promise returned by calling fn(...args).

fn

Type: Function

Promise-returning/async function.

args

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.

limit.activeCount

The number of promises that are currently running.

limit.pendingCount

The number of promises that are waiting to run (i.e. their internal fn was not called yet).

limit.clearQueue()

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.

limit.concurrency

Get or set the concurrency limit.

limitFunction(fn, options) ^{named export}

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.

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

fn

Type: Function

Promise-returning/async function.

options

Type: object

concurrency

Type: number
Minimum: 1

Concurrency limit.

FAQ

How is this different from the p-queue package?

This package is only about limiting the number of concurrent executions, while p-queue is a fully featured queue implementation with lots of different options, introspection, and ability to pause the queue.

Related

• p-throttle - Throttle promise-returning & async functions
• p-debounce - Debounce promise-returning & async functions
• p-all - Run promise-returning & async functions concurrently with optional limited concurrency
• More…