Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asfktz/awaity.js
A functional, lightweight alternative to bluebird.js, built with async / await in mind.
https://github.com/asfktz/awaity.js
async-await functional promise-library utility-library
Last synced: 3 days ago
JSON representation
A functional, lightweight alternative to bluebird.js, built with async / await in mind.
- Host: GitHub
- URL: https://github.com/asfktz/awaity.js
- Owner: asfktz
- License: mit
- Created: 2018-02-24T19:43:46.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-31T20:31:50.000Z (over 6 years ago)
- Last Synced: 2025-01-26T22:35:07.058Z (8 days ago)
- Topics: async-await, functional, promise-library, utility-library
- Language: JavaScript
- Homepage:
- Size: 3.19 MB
- Stars: 830
- Watchers: 21
- Forks: 28
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
> A functional, lightweight alternative to bluebird.js, built with `async` / `await` in mind.
## Features
- **Functional utility library for `async` / `await`**
Think `lodash` for promises.
- **Bluebird's powerful collections methods, built with native promises**
Use functions like `map`, `reduce`, `filter` & `some` to iterate over promises in an intuitive way.
- **Fine-grained Concurrency control**
Resolve all promises at once or in series of 3? the choice is yours.
- **Built to support Tree Shaking from the ground up**
Take what you need and leave the rest.
- **Two flavors: Regular & FP style**
Similar to `lodash/fp`, Awaity.js comes with additional flavor to support functional composition.
If it speaks your language, try `awaity/fp`.
## Introduction
Awaity.js is a subset of bluebird.js that focuses only on what's relevant for `async` / `await` while using native promises instead, the result is a functional utility library with a minimal footprint. much like lodash, but for promises.
That greatly reduces the library footprint, while bluebird's is 17KB min/gzip, Awaity.js takes only 2KB for the whole lib, and since it built to support [tree shaking](https://developer.mozilla.org/en-US/docs/Glossary/Tree_shaking) from the ground up, you can easily pick only what's relevant to you and end up with no more than 1KB.
```js
import { map, props } from 'awaity/esm';
const tasks = await map([1,2,3], async (id) => {
const res = await fetch(id);
return res.json();
});
console.log(tasks) // [{...}, {...}, {...}]
// Resolve a promise first
const promise = api.getTasks();
const titles = await map(promise, (task) => task.title);
// Resolve an array of a promises
const promisesArray = [ api.getTask(1), api.getTask(2), api.getTask(3)];
const titles = await map(promisesArray, (task) => task.title);
// Resolve an array of a promises + map an object of promises for each
const expendedTasks = await map(promisesArray, (task) => props({
...task,
author: api.getUser(task.authorId),
comments: api.getCommentsByTask(task.id)
}));
console.log(expendedTasks)
/*
[
{
id: 1,
title: 'Task title..',
author: { ... },
comments: [{ ... }, { ... }, { ... }]
},
{ ... },
{ ... },
{ ... }
]
*/
```
## Installation
```bash
npm install awaity
```
## Usage
```js
// Take all
import * as Async from 'awaity';
// Or only what you need
import reduce from 'awaity/reduce';
import some from 'awaity/some';
```
Or for module bundles (such as webpack, parcel, or rollup), use `awaity/esm`
Which used ES Modules to gain tree shaking support:
```js
import { map, reduce, sum } from 'awaity/esm';
```
Note: `node.js` does not support ES Modules out of the box yet.
```js
import fs from 'fs-extra';
import filter from 'awaity/filter';
async function getDirectories(path) {
const promise = fs.readdir(path);
return filter(promise, async (file) => {
const stats = await fs.stat(file);
return stats.isDirectory();
});
}
const directories = await getDirectories('.');
```
## FP flavor
Todo: explain what it means.
FP flavor is available under the `fp` submodule:
```js
import reduce from 'awaity/fp/reduce';
// OR
import { reduce } from 'awaity/esm/fp';
// Just some promises that returns numbers
const promises = [1,2,3].map((i) => Promise.resolve(i));
// By ommiting the last argument,
// we got a function that expects an array of promises
const sum = reduce((total, i) => total + i, 0);
const total = await sum(promises) // 6
```
### Chaining
Awaity.js provides three different kinds of chaining to choose from:
### By leveraging Promise's native chaining feature:
```js
import { map } from 'awaity';
const postsWithComments = await Promise.resolve([1,2,3])
.then((ids) => map(ids, (id) => api.getPostById(id)))
.then((posts) => map(posts, async (post) => ({
...post,
comments: await api.getCommentsByPostId(post.id)
})))
```
#### Promise chaining + `awaity/fp`:
```js
import { map } from 'awaity/fp';
const postsWithComments = await Promise.resolve([1,2,3])
.then(map((id) => api.getPostById(id))
.then(map(async (post) => ({
...post,
comments: await api.getCommentsByPostId(post.id)
})))
```
### Using `flow`
```js
import { map, flow } from 'awaity';
const postsWithComments = await flow([1,2,3], [
(ids) => map(ids, (id) => api.getPostById(id)),
(posts) => map(posts, async (post) => ({
...post,
comments: await api.getCommentsByPostId(post.id)
}))
]);
```
#### Using `flow` + `awaity/fp`
```js
import { map, flow } from 'awaity/fp';
const postsWithComments = await flow([
map(ids, (id) => api.getPostById(id)),
map(posts, async (post) => ({
...post,
comments: await api.getCommentsByPostId(post.id)
})
], [1,2,3]);
```
Complex example with promise chain
```js
import { map, reduce, props } from 'awaity/fp';
const posts = await Promise.resolve([1,2,3])
.then(map((id) => api.getPostById(id)))
.then(map((post) => props({
...post,
user: api.getUserById(post.userId),
comments: api.getCommentsByPostId(post.id),
})))
.then(reduce(async (results, post) => ({
...results,
[post.id]: post
})));
```
Complex example with flow
```js
import { flow, map, reduce, props } from 'awaity/esm/fp';
const posts = await flow([
map(id => api.getPostById(id)),
map(post => props({
...post,
user: api.getUserById(post.userId),
comments: api.getCommentsByPostId(post.id),
})),
reduce(async (results, post) => ({
...results,
[post.id]: post
}), {})
], [1, 2, 3]);
```
## API
### Collections
* [all](/docs/api.md#awaityall)
* [any](/docs/api.md#awaityany)
* [each](/docs/api.md#awaityeach)
* [filter](/docs/api.md#awaityfilter)
* [filterLimit](/docs/api.md#awaityfilterlimit)
* [map](/docs/api.md#awaitymap)
* [mapLimit](/docs/api.md#awaitymaplimit)
* [mapSeries](/docs/api.md#awaitymapseries)
* [props](/docs/api.md#awaityprops)
* [race](/docs/api.md#awaityrace)
* [reduce](/docs/api.md#awaityreduce)
* [some](/docs/api.md#awaitysome)
### Utilities
* [flow](/docs/api.md#awaityflow)
### FP Mode
Each module also has an equivalate curried version under the `fp` namespace
```js
import { reduce } from 'awaity/esm/fp';
// FP version is curried
reduce(reducer, initialValue, iterator)
reduce(reducer, initialValue)(iterator)
reduce(reducer)(initialValue)(iterator)
const sum = reduce((total, i) => total + i, 0);
const total = await sum(promises);
```
Note: in FP mode, the first argument (the iterable, or promises) is always the last argument.
```js
// Normal Mode: value is the first argument
reduce(iterable, reducer, initialValue);
// FP Mode: value is the last argument
reduce(reducer, initialValue, iterable);
```