run-parallel-limit
    Overview
    Documentation
    Tutorials
    Chat
    Insights
    Code
    Dependencies
    Contributors
    Jobs

run-parallel-limit

Run an array of functions in parallel, but limit the number of tasks executing at the same time

1.0.5  •  Updated 2 years ago  •  by Feross Aboukhadijeh  •  MIT License

Run an array of functions in parallel, but limit the number of tasks executing at the same time

run-parallel-limit Sauce Test Status

install

npm install run-parallel-limit

usage

parallelLimit(tasks, limit, [callback])

Run the tasks array of functions in parallel, with a maximum of limit tasks executing at the same time. If any of the functions pass an error to its callback, the main callback is immediately called with the value of the error. Once the tasks have completed, the results are passed to the final callback as an array.

Note that the tasks are not executed in batches, so there is no guarantee that the first limit tasks will complete before any others are started.

It is also possible to use an object instead of an array. Each property will be run as a function and the results will be passed to the final callback as an object instead of an array. This can be a more readable way of handling the results.

arguments
  • tasks - An array or object containing functions to run. Each function is passed a callback(err, result) which it must call on completion with an error err (which can be null) and an optional result value.
  • limit - The maximum number of tasks to run at any time.
  • callback(err, results) - An optional callback to run once all the functions have completed. This function gets a results array (or object) containing all the result arguments passed to the task callbacks.
example
var parallelLimit = require('run-parallel-limit')

var tasks = [
  function (callback) {
    setTimeout(function () {
      callback(null, 'one')
    }, 200)
  },
  function (callback) {
    setTimeout(function () {
      callback(null, 'two')
    }, 100)
  },
  ... hundreds more tasks ...
]

parallelLimit(tasks, 5, function (err, results) {
  // optional callback
  // the results array will equal ['one', 'two', ...] even though
  // the second function had a shorter timeout.
})

The above code runs with a concurrency limit of 5, so at most 5 tasks will be running at any given time.

This module is basically equavalent to async.parallelLimit, but it’s handy to just have the one function you need instead of the kitchen sink. Modularity! Especially handy if you’re serving to the browser and need to reduce your javascript bundle size.

Works great in the browser with browserify!

see also

license

MIT. Copyright © Feross Aboukhadijeh.

Popularity

Maintenance

Development

Last ver 2 years ago
Created 5 years ago
Last commit 9 months ago
1 month between commits

Technology

Node version: 8.11.1
7.4K unpacked

Compliance

MIT License
OSI Approved
0 vulnerabilities

Contributors

3 contributors
Feross Aboukhadijeh
Maintainer, 30 commits, 6 merges, 3 PRs
Works at WebTorrent, Standard
greenkeeper[bot]
4 commits
greenkeeperio-bot
2 commits, 4 PRs
Works at greenkeeperio
greenkeeper
5 PRs

Tags

parallel
async
function
callback
asynchronous
run
array
run parallel
limit
max
queue
run parallel limit
max tasks
tasks
Openbase helps developers choose among and use millions of open-source packages, so they can build amazing products faster.
FacebookTwitterLinkedIn
© 2020 Devstore, Inc.