Options
All
  • Public
  • Public/Protected
  • All
Menu

A State variable that indicates the 'current' or actual state.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly paramSet

paramSet: Parameter<Key>[] = []

Readonly prefix

prefix: Prefix

Readonly stateName

stateName: string

Methods

add

  • Adds a parameter to the parameter set

    tparam

    P the Parameter type

    Type parameters

    Parameters

    • parameter: P

      the parameter to add

    Returns CurrentState

    a new instance of this parameter set with the given parameter added

create

exists

  • Returns true if the key exists in the parameter set

    tparam

    S the Key value

    Type parameters

    Parameters

    Returns boolean

    true if the key is found

get

madd

  • Adds several parameters to the parameter set

    note

    madd ensures check for duplicate key

    tparam

    P must be a subclass of Parameter

    Type parameters

    Parameters

    • parametersToAdd: P[]

      the list of parameters to add to the parameter set

    Returns CurrentState

    a new instance of this parameter set with the given parameter added

remove

  • Remove a parameter from the parameter set by key

    tparam

    S the Key value

    Type parameters

    Parameters

    Returns CurrentState

    a new T, where T is a parameter set child with the key removed or identical if the key is not present

size

  • size(): number

Generated using TypeDoc