Function choiceKey

A KeyType that holds Choices

Tparam

L type for choices

  • choiceKey<L extends string>(
        name: string,
        choices: readonly L[],
        units?: Units,
    ): ChoiceKeyFactory<ChoiceKey<L>, readonly L[]>

  • Type Parameters

    • L extends string

    Parameters

    • name: string

      a strig for the choice key

    • choices: readonly L[]

      list of options to be made available for the choice key

    • units: Units = Units.NoUnits

      the units for the key

    Returns ChoiceKeyFactory<ChoiceKey<L>, readonly L[]>

    an instance of ChoiceKey for the given name, choices and units

Settings

Member Visibility