Class ConfigManager

The ConfigManager class is where everything happens.

The ConfigManager allows you loading your config specs definition, it also loads your actual config and lets you access it.

Hierarchy

ConfigManager

Constructors

`Private` constructor

new ConfigManager(specs: ConfigSpecs): ConfigManager
The constructor of ConfigManager is private and is called only by GetInstance to ensure it works as singleton.
Parameters
- specs: ConfigSpecs
Returns ConfigManager
- Defined in ConfigManager.ts:45

Properties

`Private` config

config: ConfigObject

`Private` specs

specs: ConfigSpecs

`Static` `Private` instance

instance: ConfigManager

Methods

GenEnv

GenEnv(): string[]
Returns string[]
- Defined in ConfigManager.ts:479

Get

Get(mod: string, key: string): any
This Getter is the safest way to access your configuration values as it will throw errors in case you try access an invalid module/key
Parameters
- mod: string
- key: string
Returns any
- Defined in ConfigManager.ts:358

Print

Print(opt: PrintOptions): void
Display the current ENV using either the logger you provide or console.log by default.
Parameters
- opt: PrintOptions
Returns void
- Defined in ConfigManager.ts:453

Validate

Validate(): boolean
Validate the config and return wheather it is valid or not

Returns boolean
- Defined in ConfigManager.ts:323

ValidateField

ValidateField(module: string, key: string): boolean
Validate a single field.
Parameters
- module: string
- key: string
  
  Key of the field
Returns boolean
- Defined in ConfigManager.ts:316

buildConfig

buildConfig(): ConfigObject
This retrieves the config and fills defaults. Additionnaly, the config object you get is decorated with a few helper fonctions such as Print, Validate, etc... to help you easily use your config

Returns ConfigObject
- Defined in ConfigManager.ts:148

getConfig

getConfig(): ConfigObject
Returns ConfigObject
- Defined in ConfigManager.ts:139

getFieldSpecs

getFieldSpecs(module: string, key: string): ConfigItem
Parameters
- module: string
- key: string
Returns ConfigItem
- Defined in ConfigManager.ts:304

getSpecs

getSpecs(): ModuleDictionnary
Returns ModuleDictionnary
- Defined in ConfigManager.ts:220

`Private` isKeyValid

isKeyValid(mod: string, key: string): boolean
Check wether the key is valid. We assume here that the module does exist
Parameters
- mod: string
- key: string
Returns boolean
- Defined in ConfigManager.ts:346

`Private` isModuleValid

isModuleValid(mod: string): boolean
Check whether the module mod is part of ours specs
Parameters
- mod: string
Returns boolean
- Defined in ConfigManager.ts:340

`Private` printItemColor

printItemColor(mod: string, item: ConfigItem, opt: PrintOptions): void
Parameters
- mod: string
- item: ConfigItem
- opt: PrintOptions
Returns void
- Defined in ConfigManager.ts:372

`Private` printItemNoColor

printItemNoColor(mod: string, item: ConfigItem, opt: PrintOptions): void
Parameters
- mod: string
- item: ConfigItem
- opt: PrintOptions
Returns void
- Defined in ConfigManager.ts:413

rebuild

rebuild(): void
Does not touch the ENV but rebuild the config. This is useful if you know that the ENV changed

Returns void
- Defined in ConfigManager.ts:252

refresh

refresh(): void
You likely will never have to use this function which is mostly use for the tests. If you don't know, do NOT call this function, it would take time and likely do nothing interesting for you.

Returns void
- Defined in ConfigManager.ts:244

`Private` validaFieldsSpecs

validaFieldsSpecs(module: string, specs: ConfigItem): boolean
This is the actual function performing the validation of a given field according to the spcs
Parameters
- module: string
- specs: ConfigItem
  
  The specs
Returns boolean
- Defined in ConfigManager.ts:273

`Static` clearInstance

clearInstance(): void
You should not use this function. It is there only for testing.

Returns void
- Defined in ConfigManager.ts:108

`Static` `Private` getEnvFile

getEnvFile(): string
This function defines what '.env' file will be loaded. By default, '.env' will be used. However, if you pass NODE_ENV=abc, the loaded file will be .env.abc

Returns string
- Defined in ConfigManager.ts:230

`Static` getInstance

getInstance(specs?: string | ConfigSpecs): ConfigManager
ConfigManager is a singleton.
Parameters
- Optional specs: string | ConfigSpecs
  
  The config specs the ConfigManager will rely on. It can be a ConfigSpecs object or the path of a file. In that case, the file can be either a YAML file or a JSON file.
Returns ConfigManager
- Defined in ConfigManager.ts:87

`Static` `Private` isregExpWithAttributes

isregExpWithAttributes(r: RegExp | RegexpWithAttributes): r is RegexpWithAttributes
Parameters
- r: RegExp | RegexpWithAttributes
Returns r is RegexpWithAttributes
- Defined in ConfigManager.ts:263

`Static` loadSpecsFromYaml

loadSpecsFromYaml(file: string): ConfigSpecs
Load specs from a YAML file
Parameters
- file: string
  
  Path of the YAML file
Returns ConfigSpecs
- Defined in ConfigManager.ts:55

`Static` loadToGlobal

loadToGlobal(): void
Calling this function will get an instance of the Config and attach it to the global scope.

Returns void
- Defined in ConfigManager.ts:259

`Static` `Private` stringToBoolean

stringToBoolean(s: string): boolean
This function converts a string to a boolean. It ignores the case and support also values such as 0 and 1, yes and no.
Parameters
- s: string
  
  String to convert
Returns boolean
- Defined in ConfigManager.ts:117

Generated using TypeDoc