Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grimmbraten/all-aboard
Perform parallel and/or sequential asynchronous tasks with ease
https://github.com/grimmbraten/all-aboard
async asynchronous await parallel promise sequence
Last synced: 6 days ago
JSON representation
Perform parallel and/or sequential asynchronous tasks with ease
- Host: GitHub
- URL: https://github.com/grimmbraten/all-aboard
- Owner: grimmbraten
- License: mit
- Created: 2021-07-27T08:31:38.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-07T09:41:29.000Z (almost 2 years ago)
- Last Synced: 2024-10-01T16:38:49.293Z (about 1 month ago)
- Topics: async, asynchronous, await, parallel, promise, sequence
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/all-aboard
- Size: 296 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
A small Javascript library to perform parallel and/or sequential asynchronous tasks with ease.
## Installation
```bash
yarn add all-aboard
```
```bash
npm install all-aboard
```
## Upgrade
```bash
yarn upgrade all-aboard --latest
```
For more information, please refer to the [yarn documentation](https://classic.yarnpkg.com/en/docs/cli/upgrade).
```bash
npm update all-aboard
```
For more information, please refer to the [npm documentation](https://docs.npmjs.com/cli/v6/commands/npm-update).
## Usage
### Sequence
The `sequence` function allows you to run asynchronous functions in order, one after the other, before proceeding on the main thread. Each asynchronous function is executed in incremental order, meaning that `tasks[0]` runs first, `tasks[1]` after that, and so on.
Uniquely to the `sequence` function, you have the option to be ejected back on the main thread if any of the asynchronous tasks are rejected. This means that if a task throws an error in the middle, the `sequence` function will not continue to run the remaining tasks.
#### Structure
```javascript
const response = await sequence(tasks[], arguments[], eject);
```
#### Example
```javascript
const { sequence } = require('all-aboard');
const arr = [async1, async2, async3];
(async () => {
await sequence(arr, ['shared', 'arguments'], true);
})();
```
### Parallel
The `parallel` function allows you to run asynchronous functions in parallel, non-blocking behavior, before proceeding on the main thread. Each asynchronous function will be executed as soon as possible, but the main thread will not proceed until each promise has been settled.
#### Structure
```javascript
const response = await parallel(tasks[], arguments[]);
```
#### Example
```javascript
const { parallel } = require('all-aboard');
(async () => {
await parallel(() => asyncFunc('with argument'), asyncFunc);
})();
```
### Arguments
If you want to run an asynchronous function without passing any arguments, you can pass the function as a task to the `sequence` or `parallel` function.
```javascript
await parallel(asyncFunc);
```
#### Specific
Things become more tricky if you want to run an asynchronous function with some passed arguments. In that case, you need to either:
1. Wrap the asynchronous function in an anonymous function.
```javascript
await sequence(() => asyncFunc('foo'));
```
2. Bind the desired arguments to the passed asynchronous function.
```javascript
await parallel(asyncFunc.bind(this, 'bar', 'baz'));
```
#### Shared
You might come across a use case where you would like to pass the same arguments to each asynchronous function in your tasks. Instead of repeating yourself, you can pass all shared arguments to the `sequence` or `parallel` function by passing them in an array after the `tasks` argument.
```javascript
await sequence(asyncFuncArr, ['foo', 'bar']);
```
**Please note** that shared arguments can be overwritten by specific arguments
### Response
Each response contains a promise summary of each executed task. If the status is `fulfilled`, the object will contain a `value` property containing the returned value from the successful task. If the status has been `rejected`, the object will instead contain a `reason` property with thrown error from the unsuccessful task.
```javascript
[
{ status: 'fulfilled', value: undefined },
{ status: 'fulfilled', value: 'returned value' },
{ status: 'rejected', reason: 'thrown error' }
];
```
## Uninstall
```bash
yarn remove all-aboard
```
```bash
npm uninstall all-aboard
```