Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brainpoint/febs-fsm
Finite state machine
https://github.com/brainpoint/febs-fsm
concurrent febs finite-state-machine fsm mechine state ts-fsm
Last synced: about 1 month ago
JSON representation
Finite state machine
- Host: GitHub
- URL: https://github.com/brainpoint/febs-fsm
- Owner: brainpoint
- License: mit
- Created: 2020-03-23T04:28:37.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-04-14T07:39:32.000Z (almost 5 years ago)
- Last Synced: 2024-12-08T03:50:12.934Z (2 months ago)
- Topics: concurrent, febs, finite-state-machine, fsm, mechine, state, ts-fsm
- Language: TypeScript
- Size: 27.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Finite state machine.
## Install
```js
npm i febs-fsm
```
`write in Typescript`.
## Example
```js
import {
State,
StateEvent,
StateMechine
} from 'febs-fsm';
// Define Event1.
class Event1 extends StateEvent {
constructor() {
super('Event1');
}
}
// Define State1.
class State1 extends State {
constructor() {
super('State1');
this.addTransition('Event1', 'State2');
}
async onProcess( event:StateEvent, nextState:State ):Promise<{transition:boolean, ret?:any}> {
return {transition: true};
}
}
// Define State2.
class State2 extends State {
constructor() {
super('State2');
}
async onProcess( event:StateEvent, nextState:State ):Promise<{transition:boolean, ret?:any}> {
return {transition: false};
}
}
// Define mechine.
class Mechine extends StateMechine {
constructor() {
super('State1'); // init state identify.
this.addState(new State1());
this.addState(new State2());
}
}
let mechine = new Mechine();
await mechine.initiate(); // initiate.
mechine.process_event(new Event1()); // process_event.
```
## Standard FSM
[standard](./lib/standard/readme.md): Store current state in mechine object. This applies to situations such as chat rooms.
```js
import {
State,
StateEvent,
StateMechine
} from 'febs-fsm';
```
### Concurrent FSM
[concurrent](./lib/concurrent/readme.md): Use the FSM concurrently. It isnot store current state in mechine object. Use context to pass the current state to FSM. Avoidance of repetition to set up FSM object.
```js
import {
State,
StateEvent,
StateMechine
} from 'febs-fsm/concurrent';
```
### Identify
The Identify of state or event use string name:
```js
// State1.
class State1 extends State {
get identify():string { return 'State1'; }
}
```
### State process flow
1. Execute `curState.onProcess`. It will do as follow, if function return `{transition:true, ret?:any}`.
2. Execute `curState.onLeave`
3. Change curState to nextState.
3. Execute `nextState.onEnter`
#### onProcess: {transition:boolean, ret:any}
- transition: Indicates whether can to transition to nextState.
- ret: Any value
#### onEnter: any
- return a any value.
It will return the `'onEnter return value'` or `'onProcess.ret'`, When call `process_event`.