Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ide/mux
Creates a promise that waits for the promises in nested data structures and resolves to data structures of the same form. It recursively traverses the input data structure and multiplexes its promises.
https://github.com/ide/mux
promise
Last synced: 7 days ago
JSON representation
Creates a promise that waits for the promises in nested data structures and resolves to data structures of the same form. It recursively traverses the input data structure and multiplexes its promises.
- Host: GitHub
- URL: https://github.com/ide/mux
- Owner: ide
- License: mit
- Created: 2015-02-03T22:13:43.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2023-10-16T20:49:11.000Z (about 1 year ago)
- Last Synced: 2024-05-01T22:28:31.854Z (6 months ago)
- Topics: promise
- Language: TypeScript
- Size: 211 KB
- Stars: 155
- Watchers: 3
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mux [](https://github.com/ide/mux/actions?query=workflow%3ATests) [](https://codecov.io/gh/ide/mux)
A simple and convenient function that resolves promises in data structures like arrays, objects, Maps, and Sets
## What is mux?
Mux is a function that multiplexes promises in nested data structures and resolves them like this:
```js
await mux({
a: asyncFunction1(),
b: asyncFunction2(),
});
// Result:
{
a: result1,
b: result2,
}
```
## Installing mux
```sh
yarn add @expo/mux
```
And import it like this:
```js
import mux from '@expo/mux';
```
## More examples
You can also pass in deeply nested data structures like this:
```js
await mux({
a: {
b: asyncFunction1(),
},
});
// Result:
{
a: {
b: result1,
},
}
```
Mux supports several standard JavaScript data structures:
```js
await mux(new Set([
asyncFunction1(),
asyncFunction2(),
]));
// Result:
new Set([
result1,
result2,
])
```
And if your promises themselves result in data structures, mux will recurse into them and resolve the nested promises.
```js
await mux([
Promise.resolve({
a: asyncFunction1(),
}),
]);
// Result:
[
{
a: result1,
},
]
```
Check out [the test suite](src/__tests__/mux-tests.js) for even more examples.
## Interesting use cases
If you've discovered a particularly interesting way to use mux, add it here and send a PR to share it.