Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/majo44/storeon-until
Small simple utility for awaiting for Storeon event occurs.
https://github.com/majo44/storeon-until
Last synced: 25 days ago
JSON representation
Small simple utility for awaiting for Storeon event occurs.
- Host: GitHub
- URL: https://github.com/majo44/storeon-until
- Owner: majo44
- License: mit
- Created: 2020-10-27T13:36:53.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-24T15:52:22.000Z (almost 2 years ago)
- Last Synced: 2024-11-28T07:46:49.288Z (about 1 month ago)
- Language: TypeScript
- Size: 273 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# storeon-until
[](https://badge.fury.io/js/storeon-substore)
[](https://travis-ci.org/majo44/storeon-substore)
[](https://coveralls.io/github/majo44/storeon-substore?branch=master)
Utility for awaiting [Storeon](https://github.com/storeon/storeon) events.
It size is 67 B (minified and gzipped) and uses [Size Limit](https://github.com/ai/size-limit) to control size.
### Overview
The goal of this tiny library is provide the easy way to awaiting occurrence of the particular
storeon event.
### Install
> npm i storeon-until --save
### Usage
#### Simple usage
From version 1.1.0 we provided the shortcut to inline the await statement with dispatch.
The returned promise contains the `dispatch` function which allows to dispatch the event on store,
that function returns the promise again.
```javascript
import { createStoreon } from "storeon";
import { until } from "storeon-until";
// create store
const store = createStoreon([]);
// some async event handler
store.on('loadDocument', async (state, id) => {
const document = await fetch(`http://some.document.com/${id}`);
store.dispatch('documentLoaded', {id, document});
});
// reducer for ending event
store.on('documentLoaded', (_, {id, document}) => ({
id,
document
}));
const {id, document} =
// awaiting for the ending event
await until(store, 'documentLoaded', (_, {id}) => id === 'id1')
// dispatch event over waiting
.dispatchOver('loadDocument', 'id1');
console.log(document);
const {id, document} =
// waits until data in state will pass condition
await until(store, '@changed', ({id}) => id === 'id2')
// dispatch event over waiting
.dispatchOver('loadDocument', 'id2');
console.log(document);
```
#### More verbose usage
```javascript
import { createStoreon } from "storeon";
import { until } from "storeon-until";
// create store
const store = createStoreon([]);
// some async event handler
store.on('loadDocument', async (state, id) => {
const document = await fetch(`http://some.document.com/${id}`);
store.dispatch('documentLoaded', {id, document});
});
// reducer for ending event
store.on('documentLoaded', (_, {id, document}) => ({
id,
document
}));
// awaiting for the ending event
const documentLoadedPromise = until(store, 'documentLoaded', (_, {id}) => id === 'id1');
// dispatch event
store.dispatch('loadDocument', 'id1');
// waits until async flow will finish
const {id, document} = await documentLoadedPromise;
console.log(document);
// we can also await for the state
const statePromise = until(store, '@changed', ({id}) => id === 'id2');
// dispatch event
store.dispatch('loadDocument', 'id2');
// waits until data in state will pass condition
const {id, document} = await statePromise;
console.log(document);
```
**Caution**
Please notice, that we should always use `until` utility to create promise before the event dispatch
as dispatched event can run synchronously.
### Api
- `until` - is function which returns `UntilResult` (which is promise) of requested event data. Params:
- `store` the store
- `event` the event which we are waiting for
- `condition` - (optional) - the function which gets state, and event data and have to return true
if promise has to be resolved for that state or data
- `UntilResult`
- `dispatchOver` - function which allows to dispatch event on the store in await place