Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sindresorhus/p-series
Run promise-returning & async functions in series
https://github.com/sindresorhus/p-series
Last synced: about 21 hours ago
JSON representation
Run promise-returning & async functions in series
- Host: GitHub
- URL: https://github.com/sindresorhus/p-series
- Owner: sindresorhus
- License: mit
- Created: 2016-11-22T07:31:48.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2021-08-12T23:31:55.000Z (over 3 years ago)
- Last Synced: 2025-01-07T11:08:55.250Z (8 days ago)
- Language: JavaScript
- Size: 13.7 KB
- Stars: 66
- Watchers: 6
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
- promise-fun - p-series - returning & async functions in series (Packages)
README
# p-series
> Run promise-returning & async functions in series
*Note:* You can just use `await` in a for-loop to get the same behavior. This package was useful before async/await existed.
If you're doing the same work in each function, use [`p-each-series`](https://github.com/sindresorhus/p-each-series) instead.
See [`p-all`](https://github.com/sindresorhus/p-all) for a concurrent counterpart.
## Install
```
$ npm install p-series
```## Usage
```js
import pSeries from 'p-series';
import got from 'got';const tasks = [
() => got('https://sindresorhus.com'),
() => checkSomething(),
() => doSomethingElse()
];console.log(await pSeries(tasks));
```## API
### pSeries(tasks)
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.
#### tasks
Type: `Iterable`
Functions are expected to return a value. If a Promise is returned, it's awaited before continuing with the next task.
## Related
- [p-all](https://github.com/sindresorhus/p-all) - Run promise-returning & async functions concurrently with optional limited concurrency
- [p-waterfall](https://github.com/sindresorhus/p-waterfall) - Run promise-returning & async functions in series, each passing its result to the next
- [p-each-series](https://github.com/sindresorhus/p-each-series) - Iterate over promises serially
- [More…](https://github.com/sindresorhus/promise-fun)