@yantrix/automata v0.0.2 • Docs
Yantrix API / @yantrix/automata / IAutomataExtendedValidatorContainer
Interface: IAutomataExtendedValidatorContainer<StateType, ActionType, EventType, ContextType, PayloadType, EventMetaType>
Interface for an Automata extended validator container.
Extends
IAutomataValidatorContainer<StateType,ActionType,EventType>.IAutomataExtendedActionContainer<ActionType,PayloadType>.IAutomataExtendedEventContainer<EventType,EventMetaType>.IAutomataExtendedStateContainer<StateType,ContextType>
Type Parameters
• StateType extends TAutomataBaseStateType
The type of the state.
• ActionType extends TAutomataBaseActionType
The type of the action.
• EventType extends TAutomataBaseEventType
The type of the event.
• ContextType extends { [K in StateType]: any }
The type of the context.
• PayloadType extends { [K in ActionType]: any }
The type of the payload.
• EventMetaType extends { [K in EventType]: any }
The type of the event metadata.
Properties
setActionValidator()
ts
setActionValidator: (actionValidator?) => this;Sets the action validator function.
Parameters
• actionValidator?: null | TValidator<ActionType>
The validator function for the action.
Returns
this
The current instance.
Inherited from
IAutomataExtendedActionContainer.setActionValidator
setEventValidator()
ts
setEventValidator: (eventValidator?) => this;Sets the event validator function.
Parameters
• eventValidator?: TValidator<EventType>
The validator function for the event.
Returns
this
The current instance.
Inherited from
IAutomataExtendedEventContainer.setEventValidator
setStateValidator()
ts
setStateValidator: (stateValidator?) => this;Sets the state validator function.
Parameters
• stateValidator?: TValidator<StateType>
The validator function for the state.
Returns
this
The current instance.
Inherited from
IAutomataExtendedStateContainer.setStateValidator
validateAction
ts
validateAction: TValidator<ActionType>;Validator function for the action.
Inherited from
IAutomataExtendedActionContainer.validateAction
validateEvent
ts
validateEvent: TValidator<EventType>;Validator function for the event.
Inherited from
IAutomataExtendedEventContainer.validateEvent
validateState
ts
validateState: TValidator<StateType>;Validator function for the state.