Class GlobalConfig<T>

Type Parameters

T extends Configuration & Record<PropertyKey, any>

Hierarchy

GlobalConfig

Index

Constructors

Properties

configuration usedAsReference

Methods

get has reset set unset

Constructors

constructor

new GlobalConfig<T>(configuration?: T): GlobalConfig<T>
The config constructor.
Type Parameters
- T extends Configuration & Record<PropertyKey, any>
Parameters
- Optional configuration: T
Returns GlobalConfig<T>
- Defined in src/Support/GlobalConfig.ts:27

Properties

`Static` `Protected` configuration

configuration: Configuration & Record<PropertyKey, any> = {}

The configuration object.

`Static` usedAsReference

usedAsReference: (string | number | symbol)[] = ...

Keys marked for not be deeply cloned when setting and returning values.

Methods

get

get<K>(key: K, defaultVal?: T[K]): T[K]
Get a value from the config.
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
- Optional defaultVal: T[K]
Returns T[K]
- Defined in src/Support/GlobalConfig.ts:39
get<D>(key: PropertyKey, defaultVal?: D): D
Type Parameters
- D
Parameters
- key: PropertyKey
- Optional defaultVal: D
Returns D
- Defined in src/Support/GlobalConfig.ts:40

has

has<K>(key: K): this is GlobalConfig<WithProperty<T, K>>
Determine whether a key is set in the config or not.
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
Returns this is GlobalConfig<WithProperty<T, K>>
- Defined in src/Support/GlobalConfig.ts:60

reset

reset(): asserts this is GlobalConfig<Partial<T>>
Empty the configuration.

Returns

Returns asserts this is GlobalConfig<Partial<T>>
- Defined in src/Support/GlobalConfig.ts:96

set

set<K>(key: K, value: T[K]): asserts this is GlobalConfig<WithProperty<T, K>>
Set a config value.
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
- value: T[K]
Returns asserts this is GlobalConfig<WithProperty<T, K>>
- Defined in src/Support/GlobalConfig.ts:70
set<K, V>(key: K, value: V): asserts this is GlobalConfig<T & { [ key in PropertyKey]: V }>
Type Parameters
- K extends PropertyKey
- V
Parameters
- key: K
- value: V
Returns asserts this is GlobalConfig<T & { [ key in PropertyKey]: V }>
- Defined in src/Support/GlobalConfig.ts:71

unset

unset<K>(key: K): asserts this is GlobalConfig<Omit<T, K>>
Remove a config value.
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
Returns asserts this is GlobalConfig<Omit<T, K>>
- Defined in src/Support/GlobalConfig.ts:87

Generated using TypeDoc