Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StateMachine<S, IO>

Type parameters

  • S: {}

  • IO: {}

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new StateMachine(initialState: StateMachineState<S>, IO?: IO, options?: Options): StateMachine

Properties

Protected IO

IO: IO

Readonly is

is: {}

Type declaration

ready

ready: Promise<this>

resolve when the state machine has been initialised

Protected Readonly to

to: {}

Type declaration

Accessors

state

  • get state(): StateMachineState<S>

Methods

Protected commit

  • commit<K>(action: K, newState: this["state"] & ReturnType<S[K]["set"]>): boolean

Protected create

  • create<T>(lens: keyof this["state"] | Lens<this["state"], InstanceType<T>["state"]> | SplitLens<this["state"], InstanceType<T>["state"]>, ModuleClass: T, IO?: Partial<ConstructorParameters<T>[1]>): Filterables<InstanceType<T>>

  • create sub state machine targeting a part of the state of the current state machine

    Type parameters

    Parameters

    • lens: keyof this["state"] | Lens<this["state"], InstanceType<T>["state"]> | SplitLens<this["state"], InstanceType<T>["state"]>
    • ModuleClass: T
    • Optional IO: Partial<ConstructorParameters<T>[1]>

    Returns Filterables<InstanceType<T>>

Protected init

  • init(): void | Promise<void>

onStateChange

  • onStateChange(listener: (state: StateMachineState<S>, action: string, target: StateContainer<any, any>, source: StateContainer<any, any>) => void): (Anonymous function)

Static create

  • create<T>(this: T, ...__namedParameters: [any, any, any]): Filterables<InstanceType<T>>

Generated using TypeDoc