awai 1.0.0-alpha-5 → 1.0.0-rc-1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +35 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -14,15 +14,45 @@
|
|
|
14
14
|
|
|
15
15
|
<br />
|
|
16
16
|
|
|
17
|
-
<p>| <a href="https://awai.
|
|
17
|
+
<p>| <a href="https://awai.js.org">Documentation</a> | <a href="https://awai.js.org/examples">Examples</a> | <a href="https://www.npmjs.com/package/awai">NPM</a> | <a href="https://github.com/yuriyyakym/awai-react">Awai-React</a> |</p>
|
|
18
18
|
</div>
|
|
19
19
|
|
|
20
20
|
---
|
|
21
21
|
|
|
22
|
-
##
|
|
22
|
+
## About
|
|
23
23
|
|
|
24
|
-
|
|
24
|
+
This library suggests an [architectural approach](https://awai.js.org/architecture), where every event is a promise-like (thennable) [AwaiEvent](https://awai.js.org/awai-event) with no terminal state.
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
AwaiEvent is a fundamental part of this library. It can re-resolve infinite amount of times, and if you await it in a loop, you have an event listener replacement.
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
Awai provides variety of nodes which were design to help with handling complex logics.
|
|
29
|
+
Every Awai node has its events, which can be mixed into any async logics, or used as trigger for [Scenarios](https://awai.js.org/scenario).
|
|
30
|
+
|
|
31
|
+
[Scenario](/scenario) is a powerful helper which helps to describe complex logics and events sequences using async functions.
|
|
32
|
+
|
|
33
|
+
Awai helps with organizing asynchronous logics and handling race conditions with ease, and it's main goal is to completely extract business logics from UI layer.
|
|
34
|
+
|
|
35
|
+
## Installation
|
|
36
|
+
|
|
37
|
+
```sh
|
|
38
|
+
npm install awai
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Documentation
|
|
42
|
+
|
|
43
|
+
- [Quick start](https://awai.js.org/quick-start)
|
|
44
|
+
- [Motivation](https://awai.js.org/motivation)
|
|
45
|
+
- [Architecture](https://awai.js.org/architecture)
|
|
46
|
+
- [Examples](https://awai.js.org/examples)
|
|
47
|
+
- Awai nodes: [State](https://awai.js.org/state), [AsyncState](https://awai.js.org/async-state), [Selector](https://awai.js.org/selector), [Action](https://awai.js.org/action), [Scenario](https://awai.js.org/scenario), [FamilyState](https://awai.js.org/family-state), [Effect](https://awai.js.org/effect)
|
|
48
|
+
- Other
|
|
49
|
+
- [AwaiEvent](https://awai.js.org/awai-event)
|
|
50
|
+
- [Registry](https://awai.js.org/registry)
|
|
51
|
+
|
|
52
|
+
## Integrations
|
|
53
|
+
|
|
54
|
+
- **React** - [NPM](https://www.npmjs.com/package/awai-react), [Repository](https://github.com/yuriyyakym/awai-react)
|
|
55
|
+
|
|
56
|
+
## Name meaning
|
|
57
|
+
|
|
58
|
+
The name comes from a Thai phrase [เอาไว้](https://www.thai2english.com/dictionary/1457374.html) which means "to keep/save/store for later".
|