trueChart Core API
interface

IVariableStorage Variable feature interface

Hierarchy

  • IVariableStorage

Index

Methods

Methods

get

  • get(name: string): Promise<string>

  • Returns the (current) value of the variable with given name in a Promise

    Parameters

    • name: string

      Name of the variable

    Returns Promise<string>

listAll

  • Returns a list of all (current) usable variables.

    Returns Promise<Map<string, IVariableContent>>

set

  • set(name: string, value: string): Promise<void>

  • Assigns the given value to the variable with given name (as definition) and returns a Promise which must be resolved after the update.

    Parameters

    • name: string

      Name of the variable

    • value: string

      Value to be set (as definition)

    Returns Promise<void>

update

  • Propagates variable updates to the TrueChartCore.

    Parameters

    • data: Map<string, IVariableContent | Partial<IVariableContent>> | Record<string, IVariableContent | Partial<IVariableContent>>

      Update data as key value pair Object/Map where the key is the variable name and the value the variable content. If the variable content is an empty object, the variable will be treated as "to be removed".

    Returns void