Yantrix

@yantrix/redux v0.0.2 • Docs

Yantrix API / @yantrix/redux / createFSMSlice

Function: createFSMSlice() ​

ts
function createFSMSlice<Actions, ContextReduxType, Automata>(options): Slice<TAutomataContext<ContextReduxType>, TReducersFSMSlice<Actions, ContextReduxType>, string, string, SliceSelectors<TAutomataContext<ContextReduxType>>>

Function for creating a wrapper around a Redux slice. Stores the current state of the FSM and returns a ready-to-use slice with reducers that correspond to the FSM's actions.

Type Parameters ​

• Actions extends string | number | symbol

Type representing possible FSM actions (string | number | symbol).

• ContextReduxType extends object

Type of the context stored in Redux.

• Automata extends TAutomata = TAutomata

Type of the FSM, which should implement TAutomata.

Parameters ​

• options: TCreateFSMSliceOptions<Automata, ContextReduxType>

Options for creating the slice:

Returns ​

Slice<TAutomataContext<ContextReduxType>, TReducersFSMSlice<Actions, ContextReduxType>, string, string, SliceSelectors<TAutomataContext<ContextReduxType>>>

Created Redux slice containing reducers that correspond to the FSM's actions and selectors.

Example ​

ts
// Example usage with the TrafficLightAutomata FSM:
const trafficLightSlice = createFSMSlice({
  Fsm: TrafficLightAutomata,
  name: 'trafficLight',
  contextToRedux: (context) => ({ color: context.state, count: context.counter }),
  selectors: {
    selectColor: (state) => state.trafficLight.color,
    selectCounter: (state) => state.trafficLight.counter,
  },
});

// Access FSM actions via dispatch:
dispatch(trafficLightSlice.actions.Switch({}));

Description ​

The function wraps the FSM into a Redux slice, storing the current state of the FSM and its context. Each FSM action automatically calls the corresponding reducer in the created slice. This approach ensures decomposition and automation of FSM logic within the Redux store structure.