Class Config

Interface to XAPI configurations.

Hierarchy

Component<this> & Gettable<any, this> & Settable<string | number, this> & Listenable<any, this>
- Config

Index

Constructors

constructor

Properties

Constructors

constructor

new Config(xapi: XAPI): Config

Inherited from Listenable(Settable(Gettable(Component))).constructor
- Defined in src/xapi/mixins.ts:17
Parameters
- xapi: XAPI
Returns Config

Properties

get

get: <T>(path: Path) => Promise<T>

Type declaration

- <T>(path: Path): Promise<T>
- Type parameters
  - T = any
  Parameters
  - path: Path
  Returns Promise<T>

normalizePath

normalizePath: (path: Path) => (string | number)[]

Type declaration

- (path: Path): (string | number)[]
- Parameters
  - path: Path
  Returns (string | number)[]

off

off: () => void

Type declaration

- (): void
- Returns void

on

on: <T>(path: Path, listener: Listener<T>) => Registration

Type declaration

- <T>(path: Path, listener: Listener<T>): Registration
- Type parameters
  - T = any
  Parameters
  - path: Path
  - listener: Listener<T>
  Returns Registration

once

once: <T>(path: Path, listener: Listener<T>) => Registration

Type declaration

- <T>(path: Path, listener: Listener<T>): Registration
- Type parameters
  - T = any
  Parameters
  - path: Path
  - listener: Listener<T>
  Returns Registration

prefix

prefix: string = 'Configuration'

set

set: (path: Path, value: string | number) => Promise<any>

Type declaration

- (path: Path, value: string | number): Promise<any>
- Parameters
  - path: Path
  - value: string | number
  Returns Promise<any>

Readonly xapi

xapi: XAPI

Generated using TypeDoc