Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConfigEntry

A class representing a configuration entry containing name, value and additional metadata

Hierarchy

  • ConfigEntry

Index

Constructors

constructor

  • Returns ConfigEntry

  • Parameters

    Returns ConfigEntry

Methods

getName

  • getName(): string
  • Set the config name

    Returns string

getSource

  • getSource(): any
  • Set the source of this configuration entry

    Returns any

getSynonyms

  • Set all config values that may be used as the value of this config along with their source, in the order of precedence

    Returns ConfigSynonym[]

getValue

  • getValue(): string
  • Set the value or null. Null is returned if the config is unset or if isSensitive is true

    Returns string

isDefault

  • isDefault(): boolean
  • Set whether the config value is the default or if it's been explicitly set

    Returns boolean

isReadOnly

  • isReadOnly(): boolean
  • Set whether the config is read-only and cannot be updated

    Returns boolean

isSensitive

  • isSensitive(): boolean
  • Set whether the config value is sensitive. The value is always set to null by the broker if the config value is sensitive

    Returns boolean

setDefault

  • Set whether the config value is the default or if it's been explicitly set

    Parameters

    • __default: boolean

    Returns ConfigEntry

setName

  • Set the config name

    Parameters

    • name: string

    Returns ConfigEntry

setReadOnly

  • Set whether the config is read-only and cannot be updated

    Parameters

    • readOnly: boolean

    Returns ConfigEntry

setSensitive

  • Set whether the config value is sensitive. The value is always set to null by the broker if the config value is sensitive

    Parameters

    • sensitive: boolean

    Returns ConfigEntry

setSource

  • Set the source of this configuration entry

    Parameters

    • source: any

    Returns ConfigEntry

setSynonyms

  • Set all config values that may be used as the value of this config along with their source, in the order of precedence

    Parameters

    Returns ConfigEntry

setValue

  • Set the value or null. Null is returned if the config is unset or if isSensitive is true

    Parameters

    • value: string

    Returns ConfigEntry

toJson

  • toJson(): {}
  • Returns {}

    • [key: string]: any

Generated using TypeDoc