Class LayeredConfigSourceAbstract

Readonlybackend

Optional Readonlyprefix

Abstractname

• get name(): string

  The name of the configuration source.

  Returns string

Abstractordinal

• get ordinal(): number

  The ordinal of the configuration source.

  Returns number

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.

Abstractload

• load(): Promise<void>

  Loads the configuration data from the configuration source.

  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.