Class LayeredModelConfigSource<T>`Abstract`

A configuration source defines the methods for reading configuration data from a configuration source. ConfigSource instances provide read-only access to configuration data.

Represents a configuration file from a file system storage backend, the contents of the shell environment, the contents of a key within a configuration map, or the contents of a key with a secret.

Type Parameters

T extends object

Hierarchy (View Summary)

LayeredConfigSource
- LayeredModelConfigSource
  - MutableModelConfigSource

Implements

ModelConfigSource<T>

Index

Constructors

`Protected`constructor

new LayeredModelConfigSource<T extends object>(
    key: string,
    schema: SchemaDefinition<T>,
    backend: ObjectStorageBackend,
    mapper: ObjectMapper,
    prefix?: string,
): LayeredModelConfigSource<T>
Type Parameters
- T extends object
Parameters
- key: string
- schema: SchemaDefinition<T>
- backend: ObjectStorageBackend
- mapper: ObjectMapper
- Optionalprefix: string
Returns LayeredModelConfigSource<T>
Overrides LayeredConfigSource.constructor
- Defined in src/data/configuration/impl/layered-model-config-source.ts:27

Properties

`Readonly`backend

backend: StorageBackend

The backend that is used to read and write configuration data.

`Protected`forest

forest: Forest

The forest model of the configuration keys and values.

Protected

`Protected` `Readonly`key

key: string

`Protected` `Readonly`mapper

mapper: ObjectMapper

`Optional` `Readonly`prefix

prefix?: string

An optional prefix that is used to filter configuration keys that are read from the configuration source.

`Readonly`schema

schema: SchemaDefinition<T>

The schema that defines the structure of the model.

Accessors

modelData

get modelData(): T
The model data that was read from the configuration source.

Returns T
Implementation of ModelConfigSource.modelData
- Defined in src/data/configuration/impl/layered-model-config-source.ts:19
set modelData(value: T): void
The model data that was read from the configuration source.
Parameters
- value: T
Returns void
Implementation of ModelConfigSource.modelData
- Defined in src/data/configuration/impl/layered-model-config-source.ts:23

`Abstract`name

get name(): string
The name of the configuration source.

Returns string
Implementation of ModelConfigSource.name
Inherited from LayeredConfigSource.name
- Defined in src/data/configuration/impl/layered-config-source.ts:32

`Abstract`ordinal

get ordinal(): number
The ordinal of the configuration source.

Returns number
Implementation of ModelConfigSource.ordinal
Inherited from LayeredConfigSource.ordinal
- Defined in src/data/configuration/impl/layered-config-source.ts:33

Methods

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.
Implementation of ModelConfigSource.asBoolean
Inherited from LayeredConfigSource.asBoolean
- Defined in src/data/configuration/impl/layered-config-source.ts:35

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.
Implementation of ModelConfigSource.asNumber
Inherited from LayeredConfigSource.asNumber
- Defined in src/data/configuration/impl/layered-config-source.ts:59

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.
Implementation of ModelConfigSource.asObject
Inherited from LayeredConfigSource.asObject
- Defined in src/data/configuration/impl/layered-config-source.ts:76

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[]
Implementation of ModelConfigSource.asObjectArray
Inherited from LayeredConfigSource.asObjectArray
- Defined in src/data/configuration/impl/layered-config-source.ts:102

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.
Implementation of ModelConfigSource.asString
Inherited from LayeredConfigSource.asString
- Defined in src/data/configuration/impl/layered-config-source.ts:128

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.
Implementation of ModelConfigSource.asStringArray
Inherited from LayeredConfigSource.asStringArray
- Defined in src/data/configuration/impl/layered-config-source.ts:132

load

load(): Promise<void>
Loads the configuration data from the configuration source.

Returns Promise<void>
Implementation of ModelConfigSource.load
Overrides LayeredConfigSource.load
- Defined in src/data/configuration/impl/layered-model-config-source.ts:53

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.
Implementation of ModelConfigSource.properties
Inherited from LayeredConfigSource.properties
- Defined in src/data/configuration/impl/layered-config-source.ts:153

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.
Implementation of ModelConfigSource.propertyNames
Inherited from LayeredConfigSource.propertyNames
- Defined in src/data/configuration/impl/layered-config-source.ts:157

Class LayeredModelConfigSource<T>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns LayeredModelConfigSource<T>

Properties

Readonlybackend

Protectedforest

Protected

Protected Readonlykey

Protected Readonlymapper

Optional Readonlyprefix

Readonlyschema

Accessors

modelData

Returns T

Parameters

Returns void

Abstractname

Returns string

Abstractordinal

Returns number

Methods

asBoolean

Parameters

Returns boolean

asNumber

Parameters

Returns number

asObject

Type Parameters

Parameters

Returns T

asObjectArray

Type Parameters

Parameters

Returns T[]

asString

Parameters

Returns string

asStringArray

Parameters

Returns string[]

load

Returns Promise<void>

properties

Returns Map<string, string>

propertyNames

Returns Set<string>

Settings

On This Page

Class LayeredModelConfigSource<T>`Abstract`

`Protected`constructor

`Readonly`backend

`Protected`forest

`Protected` `Readonly`key

`Protected` `Readonly`mapper

`Optional` `Readonly`prefix

`Readonly`schema

`Abstract`name

`Abstract`ordinal