Class ConfigManager

Hierarchy (View Summary)

GirafeSingleton
- ConfigManager

Index

Constructors

Accessors

Methods

deleteAllUserPreferences deleteUserPreference getDefaultConfigValue initMobile isNullOrUndefined isNullOrUndefinedOrBlank loadConfig loadUserPreferences saveUserPreference getInstance

Constructors

constructor

new ConfigManager(type: string): ConfigManager
Parameters
- type: string
Returns ConfigManager
Inherited from GirafeSingleton.constructor
- Defined in src/base/GirafeSingleton.ts:17

Accessors

Config

get Config(): GirafeConfig
Returns GirafeConfig
- Defined in src/tools/configuration/configmanager.ts:21

Methods

deleteAllUserPreferences

deleteAllUserPreferences(): void
DANGER: Delete all custom user preferences including custom themes in the local storage

Returns void
- Defined in src/tools/configuration/configmanager.ts:128

deleteUserPreference

deleteUserPreference(path: string): void
Delete a part of the user preferences in the local storage
Parameters
- path: string
Returns void
- Defined in src/tools/configuration/configmanager.ts:119

getDefaultConfigValue

getDefaultConfigValue(path: string): unknown
Get the original config value from the config files(s) before any custom user preferences were applied
Parameters
- path: string
Returns unknown
- Defined in src/tools/configuration/configmanager.ts:84

initMobile

initMobile(): void
Returns void
- Defined in src/tools/configuration/configmanager.ts:17

isNullOrUndefined

isNullOrUndefined(val: unknown): val is undefined | null
Parameters
- val: unknown
Returns val is undefined | null
Inherited from GirafeSingleton.isNullOrUndefined
- Defined in src/base/GirafeSingleton.ts:41

isNullOrUndefinedOrBlank

isNullOrUndefinedOrBlank(val: unknown): val is undefined | null | ""
Parameters
- val: unknown
Returns val is undefined | null | ""
Inherited from GirafeSingleton.isNullOrUndefinedOrBlank
- Defined in src/base/GirafeSingleton.ts:45

loadConfig

loadConfig(): Promise<GirafeConfig>
Returns Promise<GirafeConfig>
- Defined in src/tools/configuration/configmanager.ts:25

loadUserPreferences

loadUserPreferences(): Record<string, unknown>
Load user preferences from the local browser storage.

Returns Record<string, unknown>
the user preference object containing all custom settings.
- Defined in src/tools/configuration/configmanager.ts:95

saveUserPreference

saveUserPreference(path: string, newValue: unknown): void
Saves user preferences to the local storage.
Parameters
- path: string
- newValue: unknown
Returns void
- Defined in src/tools/configuration/configmanager.ts:103

`Static`getInstance

getInstance<T>(this: Constructor<T>): T
Type Parameters
- T
Parameters
- this: Constructor<T>
Returns T
Inherited from GirafeSingleton.getInstance
- Defined in src/base/GirafeSingleton.ts:23