Class GlobalConfig<T>

constructor

• new GlobalConfig<T>(configuration?): GlobalConfig<T>

• The config constructor.

  Type Parameters

  • T extends Configuration & Record<PropertyKey, any>

  Parameters

  • Optional configuration: T

  Returns GlobalConfig<T>

Static usedAsReference

get

• get<K>(key, defaultVal?): 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]

• get<D>(key, defaultVal?): D

• Type Parameters

  • D

  Parameters

  • key: PropertyKey

  • Optional defaultVal: D

  Returns D

has

• has<K>(key): 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>>

reset

• reset(): asserts this is GlobalConfig<Partial<T>>

• Empty the configuration.

  Returns asserts this is GlobalConfig<Partial<T>>

set

• set<K>(key, value): 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>>

• set<K, V>(key, value): 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
  }>

unset

• unset<K>(key): 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>>