Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sindresorhus/p-all
Run promise-returning & async functions concurrently with optional limited concurrency
https://github.com/sindresorhus/p-all
Last synced: about 1 month ago
JSON representation
Run promise-returning & async functions concurrently with optional limited concurrency
- Host: GitHub
- URL: https://github.com/sindresorhus/p-all
- Owner: sindresorhus
- License: mit
- Created: 2016-10-21T03:49:09.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2023-06-14T15:05:04.000Z (over 1 year ago)
- Last Synced: 2024-04-13T21:01:51.648Z (7 months ago)
- Language: JavaScript
- Size: 17.6 KB
- Stars: 298
- Watchers: 10
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Funding: .github/funding.yml
- License: license
- Security: .github/security.md
Awesome Lists containing this project
- promise-fun - p-all - returning & async functions concurrently with optional limited concurrency (Packages)
README
# p-all
> Run promise-returning & async functions concurrently with optional limited concurrency
Similar to `Promise.all()`, but accepts functions instead of promises directly so you can limit the concurrency.
If you're doing the same work in each function, use [`p-map`](https://github.com/sindresorhus/p-map) instead.
See [`p-series`](https://github.com/sindresorhus/p-series) for a serial counterpart.
## Install
```sh
npm install p-all
```
## Usage
```js
import pAll from 'p-all';
import got from 'got';
const actions = [
() => got('https://sindresorhus.com'),
() => got('https://avajs.dev'),
() => checkSomething(),
() => doSomethingElse()
];
console.log(await pAll(actions, {concurrency: 2}));
```
## API
### pAll(tasks, options?)
Returns a `Promise` that is fulfilled when all promises returned from calling the functions in `tasks` are fulfilled, or rejects if any of the promises reject. The fulfilled value is an `Array` of the fulfilled values in `tasks` order.
#### tasks
Type: `Iterable`
Iterable with promise-returning/async functions.
#### options
Type: `object`
##### concurrency
Type: `number` *(Integer)*\
Default: `Infinity`\
Minimum: `1`
Number of concurrently pending promises.
##### stopOnError
Type: `boolean`\
Default: `true`
When set to `false`, instead of stopping when a promise rejects, it will wait for all the promises to settle and then reject with an [`AggregateError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AggregateError) containing all the errors from the rejected promises.
##### signal
Type: [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal)
You can abort the promises using [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
## Related
- [p-map](https://github.com/sindresorhus/p-map) - Map over promises concurrently
- [p-series](https://github.com/sindresorhus/p-series) - Run promise-returning & async functions in series
- [p-props](https://github.com/sindresorhus/p-props) - Like `Promise.all()` but for `Map` and `Object`
- [p-queue](https://github.com/sindresorhus/p-queue) - Promise queue with concurrency control
- [p-limit](https://github.com/sindresorhus/p-limit) - Run multiple promise-returning & async functions with limited concurrency
- [More…](https://github.com/sindresorhus/promise-fun)