Class ConfigStore<T>

Load the configuration from ./etc or ./config directory, searching sub directory defined in FP8_ENV environmental variable if exists.

Tye

Type Parameters

T extends object

Index

Constructors

Properties

configDir? data getArrayCheckRegex source?

Methods

Constructors

constructor

new ConfigStore<T extends object>(
type?: new () => T,
options?: IConfigStoreOptions,
): ConfigStore<T>
Type Parameters
- T extends object
Parameters
- Optionaltype: new () => T
- Optionaloptions: IConfigStoreOptions
Returns ConfigStore<T>
- Defined in src/config.ts:45

Properties

`Optional` `Readonly`configDir

configDir?: string

Configuration file directory

`Readonly`data

data: T

Configuration Data

`Protected`getArrayCheckRegex

getArrayCheckRegex: RegExp = ...

`Optional` `Readonly`source

source?: string

Source file used to load the configuration data

Methods

get

get<O>(path: string): O
Allow retrieval of the loaded config data using the dot notation. Ie:
- 'db.username'
If [IConfigStoreOptions.loadAll] flag is set, the name of the file would be the first key. Ie: if loaded config file is called config.json, the dot notation would be:
- config.db.name
This method is not optmized and created for retro compability of FP8Config class. Avoid this method and use an actual configuration class instead.
Type Parameters
- O
Parameters
- path: string
Returns O
- Defined in src/config.ts:112