Interface IWatchDetails<T>

Type Parameters

T = IConfiguration

Hierarchy

IWatchDetails

Index

Properties

cfg rdOnly ref set setDf

Properties

cfg

cfg: T

The current config object

rdOnly

rdOnly: (<C, V>(target, name) => V)

Type declaration

- <C, V>(target, name): V
- Set this named property of the target as read-only, which will block this single named property from ever being changed for the target instance. This does NOT freeze or seal the instance, it just stops the direct re-assignment of the named property, if the value is a non-primitive (ie. an object or array) it's properties will still be mutable.
  Type Parameters
  - C
  - V = any
  Parameters
  - target: C
  - name: string
  Returns V
  The referenced properties current value

ref

ref: (<C, V>(target, name) => V)

Type declaration

- <C, V>(target, name): V
- Set this named property of the target as referenced, which will cause any object or array instance to be updated in-place rather than being entirely replaced. All other values will continue to be replaced.
  Type Parameters
  - C
  - V = any
  Parameters
  - target: C
  - name: string
  Returns V
  The referenced properties current value

set

set: (<C, V>(theConfig, name, value) => V)

Type declaration

- <C, V>(theConfig, name, value): V
- Set the value against the provided config/name with the value, the property will be converted to be dynamic (if not already) as long as the provided config is already a tracked dynamic object.
  Type Parameters
  - C
  - V
  Parameters
  - theConfig: C
  - name: string
  - value: V
  Returns V
  
  Throws
  TypeError if the provided config is not a monitored dynamic config

setDf

setDf: (<C>(theConfig, defaultValues) => C)

Type declaration

- <C>(theConfig, defaultValues): C
- Set default values for the config if not present.
  Type Parameters
  - C
  Parameters
  - theConfig: C
    
    The configuration object to set default on (if missing)
  - defaultValues: IConfigDefaults<C, IConfiguration>
    
    The default values to apply to the config
  Returns C

Generated using TypeDoc