Yantrix

@yantrix/automata v0.2.0 • Docs

Yantrix API / @yantrix/automata / TAutomataParams

Type Alias: TAutomataParams<StateType, ActionType, EventType, ContextType, PayloadType, EventMetaType> ​

ts
type TAutomataParams<StateType, ActionType, EventType, ContextType, PayloadType, EventMetaType>: TAutomataStateContext<StateType, ContextType> & object;

Parameters for automata configuration.

Type declaration ​

actionValidator? ​

ts
optional actionValidator: TValidator<ActionType>;

enabled? ​

ts
optional enabled: boolean;

eventMetaValidator? ​

ts
optional eventMetaValidator: TValidator<EventMetaType>;

eventValidator? ​

ts
optional eventValidator: TValidator<EventType>;

functionRegistry? ​

ts
optional functionRegistry: IAutomataFunctionRegistry;

paused? ​

ts
optional paused: boolean;

rootReducer ​

ts
rootReducer: TAutomataReducer<StateType, ActionType, ContextType, PayloadType> | null;

stateValidator? ​

ts
optional stateValidator: TValidator<StateType>;

Type Parameters ​

• StateType extends TAutomataBaseStateType

• ActionType extends TAutomataBaseActionType

• EventType extends TAutomataBaseEventType

• ContextType extends { [K in StateType]: any } = Record<StateType, any>

• PayloadType extends { [K in ActionType]: any } = Record<ActionType, any>

• EventMetaType extends { [K in EventType]: any } = Record<EventType, any>