Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Configuration<C>

The full configuration value, containing all settings for the current subject.

template

C The configuration schema.

Type parameters

  • C: object

Hierarchy

  • Configuration

Index

Properties

Methods

Properties

value

value: Readonly<C>

The configuration value as a plain object.

Methods

get

  • get<K>(key: K): Readonly<C[K]> | undefined
  • Returns a value at a specific key in the configuration.

    template

    C The configuration schema.

    template

    K Valid key on the configuration object.

    Type parameters

    • K: keyof C

    Parameters

    • key: K

      The name of the configuration property to get.

    Returns Readonly<C[K]> | undefined

    The configuration value, or undefined.

update

  • update<K>(key: K, value: C[K] | undefined): Promise<void>
  • Updates the configuration value for the given key. The updated configuration value is persisted by the client.

    template

    C The configuration schema.

    template

    K Valid key on the configuration object.

    Type parameters

    • K: keyof C

    Parameters

    • key: K

      The name of the configuration property to update.

    • value: C[K] | undefined

      The new value, or undefined to remove it.

    Returns Promise<void>

    A promise that resolves when the client acknowledges the update.

Generated using TypeDoc