Need help with p-limit?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

sindresorhus
786 Stars 57 Forks MIT License 45 Commits 2 Opened issues

Description

Run multiple promise-returning & async functions with limited concurrency

Services available

!
?

Need anything else?

Contributors list

# 216
exec
test-fr...
nextjs
messeng...
33 commits
# 7,970
ESLint
commiti...
semanti...
exec
2 commits
# 4,279
TypeScr...
npm
Package...
Electro...
1 commit
# 205,016
OCaml
tla
Docker
golang
1 commit
# 102,525
PHP
ESLint
eslint-...
CSS
1 commit
# 181,500
CSS
HTML
Mongoos...
express...
1 commit
# 1,101
React
JavaScr...
Babel
babel-p...
1 commit
# 33,325
asteris...
exec
Babel
test-fr...
1 commit
# 133,949
Telegra...
messeng...
cross-d...
Angular
1 commit
# 60,929
SQL
CSS
link-ch...
dialogf...
1 commit
# 5,527
TypeScr...
typescr...
iterm2
exec
1 commit

p-limit

Run multiple promise-returning & async functions with limited concurrency

Install

$ npm install p-limit

Usage

import pLimit from 'p-limit';

const limit = pLimit(1);

const input = [ limit(() => fetchSomething('foo')), limit(() => fetchSomething('bar')), limit(() => doSomething()) ];

// Only one promise is run at once const result = await Promise.all(input); console.log(result);

API

pLimit(concurrency)

Returns a

limit
function.

concurrency

Type:

number
\ Minimum:
1
\ Default:
Infinity

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.

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-queue - Promise queue with concurrency control
  • 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…

Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.