@yantrix/automata v0.0.2 • Docs
Yantrix API / @yantrix/automata
@yantrix/automata
The @yantrix/automata package is a foundational component of the Yantrix framework, designed to create and manage finite state machines (FSMs) with type-safe transitions and event handling in TypeScript.
Its core purpose is to:
- Provide the core building blocks for Yantrix FSMs
- Enable the creation of complex state machines with minimal boilerplate
- Ensure that all state transitions and event handling are type-safe
Classes
- AutomataEventAdapter
- BasicActionDictionary
- BasicEventBus
- BasicEventDictionary
- BasicStateDictionary
- FunctionDictionary
- GenericAutomata
Interfaces
- IActionDictionary
- IAutomata
- IAutomataActionContainer
- IAutomataEventAdapter
- IAutomataEventBus
- IAutomataEventContainer
- IAutomataExtendedActionContainer
- IAutomataExtendedEventContainer
- IAutomataExtendedStateContainer
- IAutomataExtendedValidatorContainer
- IAutomataFunctionRegistry
- IAutomataSlice
- IAutomataStateContainer
- IAutomataValidatorContainer
- IEventDictionary
- IStateDictionary
Type Aliases
- TAutomataActionContainer
- TAutomataActionPayload
- TAutomataBaseActionType
- TAutomataBaseEventType
- TAutomataBaseStateType
- TAutomataDispatch
- TAutomataEffect
- TAutomataEventContainer
- TAutomataEventEmitter
- TAutomataEventHandler
- TAutomataEventMetaType
- TAutomataEventStack
- TAutomataFunction
- TAutomataParams
- TAutomataQueue
- TAutomataReducer
- TAutomataStateContainer
- TAutomataStateContext
- TContextTransformer
- TDefinedValues
- TEventBusHandler
- TEventBusTask
- TValidator