Yantrix

@yantrix/automata v0.0.2 • Docs

Yantrix API / @yantrix/automata / IAutomataValidatorContainer

Interface: IAutomataValidatorContainer<StateType, ActionType, EventType> ​

Interface for an Automata validator container.

Extends ​

Extended by ​

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.

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 ​

IAutomataActionContainer.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 ​

IAutomataEventContainer.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 ​

IAutomataStateContainer.setStateValidator

validateAction ​

ts
validateAction: TValidator<ActionType>;

Validator function for the action.

Inherited from ​

IAutomataActionContainer.validateAction

validateEvent ​

ts
validateEvent: TValidator<EventType>;

Validator function for the event.

Inherited from ​

IAutomataEventContainer.validateEvent

validateState ​

ts
validateState: TValidator<StateType>;

Validator function for the state.

Inherited from ​

IAutomataStateContainer.validateState