Class ConfigReader

An implementation of the Config interface that uses a plain JavaScript object for the backing data, with the ability of linking multiple readers together.

Implements

Config

Index

Constructors

Methods

get getBoolean getConfig getConfigArray getNumber getOptional getOptionalBoolean getOptionalConfig getOptionalConfigArray getOptionalNumber getOptionalString getOptionalStringArray getString getStringArray has keys fromConfigs

Constructors

constructor

new ConfigReader(
    data: JsonObject | undefined,
    context?: string,
    fallback?: ConfigReader,
    prefix?: string,
): ConfigReader
Parameters
- data: JsonObject | undefined
- context: string = 'mock-config'
- Optionalfallback: ConfigReader
- prefix: string = ''
Returns ConfigReader
- Defined in packages/config/src/reader.ts:147

Methods

get

get<T = JsonValue>(key?: string): T
Type Parameters
- T = JsonValue
Parameters
- Optionalkey: string
Returns T
Implementation of Config.get
- Defined in packages/config/src/reader.ts:181

getBoolean

getBoolean(key: string): boolean
Parameters
- key: string
Returns boolean
Implementation of Config.getBoolean
- Defined in packages/config/src/reader.ts:325

getConfig

getConfig(key: string): ConfigReader
Parameters
- key: string
Returns ConfigReader
Implementation of Config.getConfig
- Defined in packages/config/src/reader.ts:223

getConfigArray

getConfigArray(key: string): ConfigReader[]
Parameters
- key: string
Returns ConfigReader[]
Implementation of Config.getConfigArray
- Defined in packages/config/src/reader.ts:251

getNumber

getNumber(key: string): number
Parameters
- key: string
Returns number
Implementation of Config.getNumber
- Defined in packages/config/src/reader.ts:296

getOptional

getOptional<T = JsonValue>(key?: string): T | undefined
Type Parameters
- T = JsonValue
Parameters
- Optionalkey: string
Returns T | undefined
Implementation of Config.getOptional
- Defined in packages/config/src/reader.ts:190

getOptionalBoolean

getOptionalBoolean(key: string): boolean | undefined
Parameters
- key: string
Returns boolean | undefined
Implementation of Config.getOptionalBoolean
- Defined in packages/config/src/reader.ts:334

getOptionalConfig

getOptionalConfig(key: string): ConfigReader | undefined
Parameters
- key: string
Returns ConfigReader | undefined
Implementation of Config.getOptionalConfig
- Defined in packages/config/src/reader.ts:232

getOptionalConfigArray

getOptionalConfigArray(key: string): ConfigReader[] | undefined
Parameters
- key: string
Returns ConfigReader[] | undefined
Implementation of Config.getOptionalConfigArray
- Defined in packages/config/src/reader.ts:260

getOptionalNumber

getOptionalNumber(key: string): number | undefined
Parameters
- key: string
Returns number | undefined
Implementation of Config.getOptionalNumber
- Defined in packages/config/src/reader.ts:305

getOptionalString

getOptionalString(key: string): string | undefined
Parameters
- key: string
Returns string | undefined
Implementation of Config.getOptionalString
- Defined in packages/config/src/reader.ts:366

getOptionalStringArray

getOptionalStringArray(key: string): string[] | undefined
Parameters
- key: string
Returns string[] | undefined
Implementation of Config.getOptionalStringArray
- Defined in packages/config/src/reader.ts:384

getString

getString(key: string): string
Parameters
- key: string
Returns string
Implementation of Config.getString
- Defined in packages/config/src/reader.ts:357

getStringArray

getStringArray(key: string): string[]
Parameters
- key: string
Returns string[]
Implementation of Config.getStringArray
- Defined in packages/config/src/reader.ts:375

has

has(key: string): boolean
Parameters
- key: string
Returns boolean
Implementation of Config.has
- Defined in packages/config/src/reader.ts:160

keys

keys(): string[]
Returns string[]
Implementation of Config.keys
- Defined in packages/config/src/reader.ts:172

`Static`fromConfigs

fromConfigs(configs: AppConfig[]): ConfigReader
Instantiates the config reader from a list of application config objects.
Parameters
- configs: AppConfig[]
Returns ConfigReader
- Defined in packages/config/src/reader.ts:113