Class ValueComponent<TName, TValue, TInput>

constructor

• new ValueComponent<
      TName extends string = string,
      TValue extends unknown = unknown,
      TInput extends unknown = TValue,
  >(
      name: TName,
      zodType: ZodType<unknown>,
  ): ValueComponent<TName, TValue, TInput>

  Type Parameters

  • TName extends string = string
  • TValue extends unknown = unknown
  • TInput extends unknown = TValue

  Parameters

  • name: TName
  • zodType: ZodType<unknown>

  Returns ValueComponent<TName, TValue, TInput>

Readonlyname

ReadonlyzodType

getValue

• getValue(): Promise<undefined | TValue>

  Function for receiving the value of a component.

  Returns Promise<undefined | TValue>

onValueChanged

• onValueChanged(
      listener: CmpValueChangedListener<TValue>,
      callImmediately?: boolean,
      condition?: CmpValueChangedCondition<TValue>,
  ): void

  Parameters

  • listener: CmpValueChangedListener<TValue>

    Called whenever the value of the given cmp has changed
  • callImmediately: boolean = false

    True: The listener is immediately called with the current value of the cmp at the time, the listener is added
    False: The listener will be called for the first time when the value of the cmp actually changes
  • Optionalcondition: CmpValueChangedCondition<TValue>

    A predicate function which is given the new cmp value.
    The function can decide on whether the listener is called or not by returning true or false.

  Returns void

setInput

• setInput(value: undefined | TInput): Promise<void>

  Sends the ChangeConfigurationValue request to the server

  Parameters

  • value: undefined | TInput

  Returns Promise<void>