SideEffect | Automatons

Class that represents a special side effect transition.

Hierarchy

Transition
- SideEffect

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SideEffect(state: State, signal: Signal | undefined, implementation: SideEffectImplementation): SideEffect

Overrides Transition.constructor
- Defined in classes/SideEffect.ts:11
Parameters
- state: State
- signal: Signal | undefined
- implementation: SideEffectImplementation
Returns SideEffect

Properties

implementation

implementation: TransitionFunction

the next state or a function that returns one

signal

signal: Signal | undefined

signal, that triggers the transition, or undefined if it is an unconditional transition

state

state: State

state from which the transition is possible

Methods

onConditionsMet

onConditionsMet(stateMachine: Automaton): void

Inherited from Transition.onConditionsMet
- Defined in classes/Automaton.ts:69
This lifecycle method is triggered when all conditions are met to perform a transition.

Parameters
- stateMachine: Automaton
Returns void

onConditionsUnmet

onConditionsUnmet(stateMachine: Automaton): void

Inherited from Transition.onConditionsUnmet
- Defined in classes/Automaton.ts:76
This lifecycle method is triggered when conditions to perform a transition are no longer met

Parameters
- stateMachine: Automaton
Returns void

Generated using TypeDoc