Class TemplateStateMachine<EventPayloadMapping, Context, States>`Abstract`

Type Parameters

EventPayloadMapping
Context
States extends string = "IDLE"

Hierarchy (View Summary)

TemplateStateMachine

Implements

StateMachine<EventPayloadMapping, Context, States>

Index

Constructors

Properties

_context _currentState _happensCallbacks _stateChangeCallbacks _states _statesArray

Accessors

currentState possibleStates states

Methods

happens onHappens onStateChange setContext switchTo

Constructors

constructor

new TemplateStateMachine<
    EventPayloadMapping,
    Context,
    States extends string = "IDLE",
>(
    states: Record<States, State<EventPayloadMapping, Context, States>>,
    initialState: States,
    context: Context,
): TemplateStateMachine<EventPayloadMapping, Context, States>
Type Parameters
- EventPayloadMapping
- Context
- States extends string = "IDLE"
Parameters
- states: Record<States, State<EventPayloadMapping, Context, States>>
- initialState: States
- context: Context
Returns TemplateStateMachine<EventPayloadMapping, Context, States>
- Defined in being/interfaces.ts:53

Properties

`Protected`_context

_context: Context

`Protected`_currentState

_currentState: States

`Protected`_happensCallbacks

_happensCallbacks: (
    event: keyof EventPayloadMapping,
    payload: EventPayloadMapping[keyof EventPayloadMapping],
    context: Context,
) => void[]

`Protected`_stateChangeCallbacks

_stateChangeCallbacks: StateChangeCallback<EventPayloadMapping, Context, States>[]

`Protected`_states

_states: Record<States, State<EventPayloadMapping, Context, States>>

`Protected`_statesArray

_statesArray: States[]

Accessors

currentState

get currentState(): States
Returns States
- Defined in being/interfaces.ts:85

possibleStates

get possibleStates(): States[]
Returns States[]
Implementation of StateMachine.possibleStates
- Defined in being/interfaces.ts:93

states

get states(): Record<States, State<EventPayloadMapping, Context, States>>
Returns Record<States, State<EventPayloadMapping, Context, States>>
Implementation of StateMachine.states
- Defined in being/interfaces.ts:97

Methods

happens

happens<K extends string | number | symbol>(
    event: K,
    payload: EventPayloadMapping[K],
    context: Context,
): States
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- payload: EventPayloadMapping[K]
- context: Context
Returns States
Implementation of StateMachine.happens
- Defined in being/interfaces.ts:66

onHappens

onHappens(
    callback: (
        event: keyof EventPayloadMapping,
        payload: EventPayloadMapping[keyof EventPayloadMapping],
        context: Context,
    ) => void,
): void
Parameters
- callback: (
      event: keyof EventPayloadMapping,
      payload: EventPayloadMapping[keyof EventPayloadMapping],
      context: Context,
  ) => void
Returns void
Implementation of StateMachine.onHappens
- Defined in being/interfaces.ts:81

onStateChange

onStateChange(
callback: StateChangeCallback<EventPayloadMapping, Context, States>,
): void
Parameters
- callback: StateChangeCallback<EventPayloadMapping, Context, States>
Returns void
Implementation of StateMachine.onStateChange
- Defined in being/interfaces.ts:77

setContext

setContext(context: Context): void
Parameters
- context: Context
Returns void
Implementation of StateMachine.setContext
- Defined in being/interfaces.ts:89

switchTo

switchTo(state: States): void
Parameters
- state: States
Returns void
Implementation of StateMachine.switchTo
- Defined in being/interfaces.ts:62