Class ValueComponent<TName, TValue, TInput>

Represents a component of type Value

Type Parameters

Hierarchy

Implements

Constructors

constructor

Properties

name

Methods

getValue onValueChanged setInput

Constructors

constructor

  • Type Parameters

    • TName extends string = string

    • TValue extends unknown = unknown

    • TInput extends unknown = TValue

    Parameters

    • name: TName
    • zodObj: ZodType<unknown, ZodTypeDef, unknown>

    Returns ValueComponent<TName, TValue, TInput>

Properties

Readonly name

name: TName

Methods

getValue

  • Function for receiving the value of a component.

    Returns Promise<undefined | TValue>

onValueChanged

  • 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

    • Optional condition: 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

  • Sends the ChangeConfigurationValue request to the server

    Parameters

    • value: undefined | TInput
    • defer: boolean = true

      Defers the actual request after the current execution context.
      All values from subsequent calls to setCmpInput within the same execution context will be sent as 1 batch request if defer = true.

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc