Skip to content

@yantrix/automata v0.5.2 • Docs


Yantrix API / @yantrix/automata / IAutomataExtendedEventContainer

Interface: IAutomataExtendedEventContainer<EventType, EventMetaType> ​

Interface for an Automata extended event container.

Extends ​

Extended by ​

Type Parameters ​

• EventType extends TAutomataBaseEventType

The type of the event.

• EventMetaType extends { [K in EventType]: any }

The type of the event metadata.

Properties ​

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


validateEvent ​

ts
validateEvent: TValidator<EventType>;

Validator function for the event.

Inherited from ​

IAutomataEventContainer.validateEvent