Class LocalConfigSource

Readonlybackend

Optional Readonlyprefix

Readonlyschema

modelData

• get modelData(): T

  The model data that was read from the configuration source.

  Returns T
• set modelData(value: T): void

  The model data that was read from the configuration source.

  Parameters

  • value: T

  Returns void

asBoolean

• asBoolean(key: string): boolean

  Retrieves the value of the specified key from the configuration source and converts it to a boolean.

  Parameters

  • key: string

    The key to use to retrieve the value from the configuration source.

  Returns boolean

  The value of the specified key as a boolean.

asNumber

• asNumber(key: string): number

  Retrieves the value of the specified key from the configuration source and converts it to a number.

  Parameters

  • key: string

    The key to use to retrieve the value from the configuration source.

  Returns number

  The value of the specified key as a number.

asObject

• asObject<T>(cls: ClassConstructor<T>, key?: string): T

  Retrieves the value of the specified key from the configuration source and converts it an object of the specified type. If the key is not specified, the method returns the entire configuration as an object.

  Type Parameters

  • T

  Parameters

  • cls: ClassConstructor<T>

    The class of the object to which the value should be converted.
  • Optionalkey: string

    The key to use to retrieve the value from the configuration source.

  Returns T

  The value of the specified key as a boolean.

asObjectArray

• asObjectArray<T extends T[]>(cls: ClassConstructor<T>, key: string): T[]

  Retrieves the value of the specified key from the configuration source and converts it to an array of objects of the specified type. If the key is not specified, the method returns the entire configuration as an array of objects.

  Type Parameters

  • T extends T[]

  Parameters

  • cls: ClassConstructor<T>

    The class of the objects to which the values should be converted.
  • key: string

    The key to use to retrieve the values from the configuration source.

  Returns T[]

asString

• asString(key: string): string

  Retrieves the value of the specified key from the configuration source and converts it to a string.

  Parameters

  • key: string

    The key to use to retrieve the value from the configuration source.

  Returns string

  The value of the specified key as a string.

asStringArray

• asStringArray(key: string): string[]

  Retrieves the value of the specified key from the configuration source and converts it to a string array.

  Parameters

  • key: string

    The key to use to retrieve the value from the configuration source.

  Returns string[]

  The value of the specified key as a string array.

load

• load(): Promise<void>

  Loads the configuration data from the configuration source.

  Returns Promise<void>

persist

• persist(): Promise<void>

  Persists the configuration source to the underlying storage backend.

  Returns Promise<void>

properties

• properties(): Map<string, string>

  Enumerates the key-value pairs that are available in the configuration source.

  Returns Map<string, string>

  A map of key-value pairs that are available in the configuration source.

propertyNames

• propertyNames(): Set<string>

  Enumerates the set of property names that are available in the configuration source.

  Returns Set<string>

  A set of property names that are available in the configuration source.

putObject

• putObject<T>(key: string, value: T): void

  Puts an object value into the configuration.

  Type Parameters

  • T

  Parameters

  • key: string

    The key to use to store the value in the configuration.
  • value: T

    The value to store in the configuration.

  Returns void

putObjectArray

• putObjectArray<T>(key: string, value: T[]): void

  Puts an array of object values into the configuration.

  Type Parameters

  • T

  Parameters

  • key: string

    The key to use to store the values in the configuration.
  • value: T[]

    The values to store in the configuration.

  Returns void

putScalar

• putScalar(key: string, value: Primitive): void

  Puts a scalar value into the configuration.

  Parameters

  • key: string

    The key to use to store the value in the configuration.
  • value: Primitive

    The value to store in the configuration.

  Returns void

putScalarArray

• putScalarArray(key: string, value: Primitive[]): void

  Puts an array of string, boolean or numeric values into the configuration.

  Parameters

  • key: string

    The key to use to store the values in the configuration.
  • value: Primitive[]

    The values to store in the configuration.

  Returns void