Class MutableModelConfigSource<T>`Abstract`

Indicates a configuration source that can be persisted.

Type Parameters

T extends object

Hierarchy (View Summary)

LayeredModelConfigSource<T>
- MutableModelConfigSource
  - LocalConfigSource
  - RemoteConfigSource

Implements

Index

Constructors

`Protected`constructor

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

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
Inherited from LayeredModelConfigSource.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
Inherited from LayeredModelConfigSource.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
Inherited from LayeredModelConfigSource.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
Inherited from LayeredModelConfigSource.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 ConfigMutator.asBoolean
Inherited from LayeredModelConfigSource.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 ConfigMutator.asNumber
Inherited from LayeredModelConfigSource.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 ConfigMutator.asObject
Inherited from LayeredModelConfigSource.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 ConfigMutator.asObjectArray
Inherited from LayeredModelConfigSource.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 ConfigMutator.asString
Inherited from LayeredModelConfigSource.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 ConfigMutator.asStringArray
Inherited from LayeredModelConfigSource.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>
Inherited from LayeredModelConfigSource.load
- Defined in src/data/configuration/impl/layered-model-config-source.ts:53

persist

persist(): Promise<void>
Persists the configuration source to the underlying storage backend.

Returns Promise<void>
Implementation of Persistable.persist
- Defined in src/data/configuration/impl/mutable-model-config-source.ts:29

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 ConfigMutator.properties
Inherited from LayeredModelConfigSource.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 ConfigMutator.propertyNames
Inherited from LayeredModelConfigSource.propertyNames
- Defined in src/data/configuration/impl/layered-config-source.ts:157

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
Implementation of ConfigMutator.putObject
- Defined in src/data/configuration/impl/mutable-model-config-source.ts:37

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
Implementation of ConfigMutator.putObjectArray
- Defined in src/data/configuration/impl/mutable-model-config-source.ts:46

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
Implementation of ConfigMutator.putScalar
- Defined in src/data/configuration/impl/mutable-model-config-source.ts:55

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
Implementation of ConfigMutator.putScalarArray
- Defined in src/data/configuration/impl/mutable-model-config-source.ts:69

Class MutableModelConfigSource<T>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns MutableModelConfigSource<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>

persist

Returns Promise<void>

properties

Returns Map<string, string>

propertyNames

Returns Set<string>

putObject

Type Parameters

Parameters

Returns void

putObjectArray

Type Parameters

Parameters

Returns void

putScalar

Parameters

Returns void

putScalarArray

Parameters

Returns void

Settings

On This Page

Class MutableModelConfigSource<T>`Abstract`

`Protected`constructor

`Readonly`backend

`Protected`forest

`Protected` `Readonly`key

`Protected` `Readonly`mapper

`Optional` `Readonly`prefix

`Readonly`schema

`Abstract`name

`Abstract`ordinal