Javascript API

When generating a JS/TS class, it has @yantrix/automata as dependency and implements IAutomata interface. The exported class also has static properties to facilitate operating the FSM and its constants.

In this section, all snippets are provided with the same diagram analyzed in Introduction:

Identifier

Yantrix codegen lets you specify a paremeter className, which whill result in the name of the generated Class. However, when using default imports, this name is lost, while it's could be a good unique identifier, when using a lot of FSMs. To keep it, every exported class has a static property id containing the same name

$ yantrix codegen ./slider.mermaid --outfile slider_controller.js --language Javascript --className Slider

import { Slider } from '../slider_controller.js';
// or
import Slider from '../slider_controller.js';

Slider.id === 'Slider'; // true

State Helpers

Internally, IAutomata operates on numeric states. To address States from the diagram, they must be wrapped in a helper:

import Slider from '../slider_controller.js';

Slider.getState('ENABLED'); // returns a numeric internal id of this State, or Null if it's incorrect

There's also a helper to check if the FSM is in a particular State right now:

const SliderInstance = new Slider({
	min: 1,
	max: 10,
	value: 5,
});

Slider.hasState(SliderInstance, 'ENABLED'); // true
// this is the same as
Slider.getState('ENABLED') === SliderInstance.getContext().state;

Action Helpers

To invoke an Action, a dispatch method should be used. Since it accepts numeric ids, they also have to be mapped.

Slider.getAction('DISABLE');
Slider.getAction('ENABLE');

Since most of the time you need to pass a Payload object into dispatch, there's a helper to create a Payload:

const payload = Slider.createAction('RESET', {
	min: 0,
	max: 50,
});

Slider.dispatch(payload);

Dictionaries

Generated modules export two kinds of dictionaries both for Actions and States, that are suggested to be used as reference constants when addressing their identifiers:

import { actionDictionary, actionMap } from '../slider_controller.js';

assert.isEqual(actionMap, {
	RESET: 'RESET',
	ENABLE: 'ENABLE',
	DISABLE: 'DISABLE',
	SET: 'SET',
	INCREASE: 'INCREASE',
	DECREASE: 'DECREASE',
}); // true

// actionDictionary keys are the same as of actionMap
// actionDictionary values are generated semi-randon numbers, that are actually used in the FSM

SliderInstance.dispatch(Slider.createAction(actionMap.DISABLE));

Same dictionaries are provided for States:

import { stateDictionary, stateMap } from '../slider_controller.js';

Slider.getState(stateMap.ENABLED);

Typescript

In typescript versions Dictionaries are available as types too:

import { actionMap, TActionLiteral, stateMap, TStateLiteral } from '../slider_controller.js';

type TActionLiteral = keyof typeof actionMap;
type TStateLiteral = keyof typeof stateMap;