Interface IImmutableStateMachine<T>

The public APIs of the IStateMachine

Type parameters

T

Hierarchy

IImmutableStateMachine

Implemented by

TypedStateMachine

Index

Methods

Methods

bindHookHandler

bindHookHandler(applyToStates: T | Array<T>, hookType: StateHookType, handler: HookHandler<T>): void

- Defined in models/i-immutable-state-machine.interface.ts:41
Add a new hook handler in the specified state and hook type.

If an hook already exist with the same combination of state and hookType it will be replaced.

Parameters
- applyToStates: T | Array<T>
  
  The state associated to this hook
- hookType: StateHookType
  
  The hook type
- handler: HookHandler<T>
  
  The executed handler
Returns void

can

can(newState: T): boolean

- Defined in models/i-immutable-state-machine.interface.ts:24
Return true if a transition exist from the current state to the new state, false otherwise

Parameters
- newState: T
  
  The new state
Returns boolean

getAllStates

getAllStates(): Array<StateInfo<T>>

- Defined in models/i-immutable-state-machine.interface.ts:18
Return all the states involved at least in one transition

Returns Array<StateInfo<T>>

getNextStates

getNextStates(): Array<T>

- Defined in models/i-immutable-state-machine.interface.ts:29
Return the reachable states from the current one

Returns Array<T>

getState

getState(): T

- Defined in models/i-immutable-state-machine.interface.ts:13
Return the current state

Returns T

Generated using TypeDoc