pleshevskiy / it-fsm

Simple full-featured finite state machine for your project. Mirror of https://git.pleshevski.ru/pleshevskiy/it-fsm

IT FSM

Simple full-featured finite state machine for your project

Why it-fsm?

• 🚯 333 LOC - 0 dependencies
• 🍒 Sophisticated object-oriented design

Getting started

import { StateMachineBuilder } from "it-fsm";

const [locked, unlocked] = ["locked", "unlocked"] as const;

const sm = new StateMachineBuilder()
  .withStates([locked, unlocked])
  .withTransitions([
    [locked, { coin: unlocked }],
    [unlocked, { push: locked }],
  ])
  .build(locked);

You can find more examples here

Installation

Deno

if you use the Deno, just add the following to your import_map.json

{
  "imports": {
    "it-fsm": "https://git.pleshevski.ru/pleshevskiy/it-fsm/raw/tag/v2.0.3/fsm.ts"
  }
}

Node.js

If you use the Node.js or in a browser as ES module, you may need to install it as follows, and additionally you can add import maps for client side.

npm install --save it-fsm

License

GNU General Public License v3.0 or later

See COPYING to see the full text.

it-fsm's Issues

Add better example

Use Map instead Object

Object can have only string keys and it's problem. Currently we have crutch with number key. We test key by regex and parse it.

With Map object we may store any object as a key!

Get action by state

Imagine FSM for task statuses. We want to handle state action if status change. We shouldn't copy-paste if-else condition to run state action. The FSM should give us a method to get action by state.