Class Result

ReadonlyparamSet

add

• add<P extends Parameter<Key>>(parameter: P): Result

• Adds a parameter to the parameter set

  Type Parameters

  • P extends Parameter<Key>

  Parameters

  • parameter: P

    the parameter to add

  Returns Result

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

  Tparam

  P the Parameter type

exists

• exists<S extends Key>(key: BaseKeyType<S>): boolean

• Returns true if the key exists in the parameter set

  Type Parameters

  • S extends Key

  Parameters

  • key: BaseKeyType<S>

    the key to check for

  Returns boolean

  true if the key is found

  Tparam

  S the Key value

get

• get<S extends Key>(key: BaseKeyType<S>): Option<Parameter<S>>

• Returns an Option with the parameter for the key if found, otherwise undefined

  Type Parameters

  • S extends Key

  Parameters

  • key: BaseKeyType<S>

    the Key to be used for lookup

  Returns Option<Parameter<S>>

  the parameter for the key, if found

  Tparam

  S the value type

madd

• madd<P extends Parameter<Key>>(parametersToAdd: P[]): Result

• Adds several parameters to the parameter set

  Type Parameters

  • P extends Parameter<Key>

  Parameters

  • parametersToAdd: P[]

    the list of parameters to add to the parameter set

  Returns Result

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

  Note

  madd ensures check for duplicate key

  Tparam

  P must be a subclass of Parameter

remove

• remove<S extends Key>(key: BaseKeyType<S>): Result

• Remove a parameter from the parameter set by key

  Type Parameters

  • S extends Key

  Parameters

  • key: BaseKeyType<S>

    the Key to be used for removal

  Returns Result

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

  Tparam

  S the Key value

size

• size(): number

• The number of parameters in this parameter set

  Returns number

  the number of parameters in the parameter set