Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/feats/radiaction
Powerful nodejs library for building seamless distributed applications.
https://github.com/feats/radiaction
action-reaction distributed-computing distributed-systems kafka message-broker message-bus message-queue nodejs
Last synced: about 11 hours ago
JSON representation
Powerful nodejs library for building seamless distributed applications.
- Host: GitHub
- URL: https://github.com/feats/radiaction
- Owner: feats
- Created: 2018-03-24T12:35:52.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-04-03T08:12:15.000Z (over 6 years ago)
- Last Synced: 2024-10-22T23:45:05.879Z (2 months ago)
- Topics: action-reaction, distributed-computing, distributed-systems, kafka, message-broker, message-bus, message-queue, nodejs
- Language: JavaScript
- Homepage:
- Size: 5.86 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Powerful nodejs library for building seamless distributed applications.
Radiaction makes it painless for Developers to write distributed apps and for DevOps to keep everything running.
[ Check examples 👌 | Read the API 🤓 ]
* **Agnosticism:** With _Radiaction_, developers don't need to know _how_/_where_/_when_ their distributed functions will be running.
* **Modularity:** Encapsulated modules containing actions and reactions next to each other allow developers to keep coding with the mindset of a non distributed application.
* **Separation of concerns:** DevOps don't need to interfere on how developers are writting their functions. Scaling and even changing the infrasctructure can be done independently by DevOps with no change in the application code.
> **WARNING ⚠️** This is an experimental project. It's use is not yet recommended for production.
>
> Please, consider helping us on the [path to stability](https://github.com/Quadric/radiaction/milestone/1) by contributing to this project 🍻💪
## API
* [Application side](#application-side)
* [Higher-order functions](#higher-order-functions)
* [emitter](#emitter)
* [topicfy](#topicfy)
* [waiter](#waiter)
* [Utilities](#utilities)
* [compose](#compose)
* [Distributed side](#distributed-side)
* [createTopics](#createtopics)
* [runner](#runner)
### Application side
#### Higher-order functions
##### emitter
```typescript
import { emitter } from 'radiaction'
emitter(actionsMap: Object): Object
```
For each action, wraps it with a function that:
* when called, dispatches a message to the broker, ultimately triggering the subscribed reaction.
* returns the location of the dispatched message in the broker (async/promise).
##### topicfy
```typescript
import { topicfy } from 'radiaction'
topicfy(moduleName: String)(actionsMap: Object): Object
```
Sanitizes the functions names while combining them with the provided key (`moduleName`). The resulting function names can be used as _topic_ names.
##### waiter
```typescript
import { waiter } from 'radiaction'
waiter(actionsMap: Object): Object
```
For each action, wraps it with a function that:
* when called, notifies the broker that the given action is waiting for the output of its respective reaction.
* returns the output of its respective reaction once its available (async/promise).
#### Utilities
##### compose
```typescript
import { compose } from 'radiaction'
compose(...functions: Array)
```
Composes functions from right to left. You might want to use it to compose multiple higher-order functions into a single higher-order function.
This is a functional programming utility, and is included here as a convenience. It works exactly like the function of the same name in [Recompose](https://github.com/acdlite/recompose/blob/master/docs/API.md#compose) and [Redux](https://github.com/reactjs/redux/blob/master/docs/api/compose.md), or [lodash's `flowRight()`](https://lodash.com/docs/4.17.5#flowRight).
### Distributed side
##### createTopics
```typescript
import { createTopics } from 'radiaction'
createTopics(actionsMap: Object): Promise
```
Initializes the topics for every action. It only needs to be executed once.
##### runner
```typescript
import { runner } from 'radiaction'
runner(reactionsMap: Object): Promise
```
Start runners that will subscribe to the topics associated with each action. It will:
* execute the associated reaction
* notify the broker that the output of the reaction is available.
## Examples
Take a look at the [examples](./examples) folder in order to see our available demos.