Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StateContainer<State, IO>

Type parameters

  • State

  • IO: {}

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected IO

IO: IO

Private _options

_options: RootOptions | LeafOptions<State>

Private Optional _state

_state: State

Private _stateChanged

_stateChanged: CustomSignal<State, string, StateContainer<any, any>, StateContainer<any, any>> = new CustomSignal<State,string,StateContainer<any, any>,StateContainer<any, any>>()

Private Optional _unsubscribe

_unsubscribe: () => void

Type declaration

    • (): void

    • Returns void

ready

ready: Promise<this>

resolve when the state machine has been initialised

Accessors

state

  • get state(): State

Methods

Private _updateState

  • _updateState(newState: State, action: string, target: StateContainer<any, any>): void

Protected commit

  • commit(action: string, newState: State): boolean

  • update the state machine state

    Parameters

    • action: string
    • newState: State

    Returns 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>

  • implement to perform actions before the state machine is declared ready

    Returns void | Promise<void>

onStateChange

  • onStateChange(listener: (state: State, 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