Interface: ConfigApi

ConfigApi.ConfigApi

Description

Contains APIs to set and retrieve the application configuration

Properties

• getConfig
• onConfigLoaded
• setConfig

Properties

getConfig

• getConfig: () => ConfigSettings

Type declaration

• (): ConfigSettings

Returns

ConfigSettings

An object of configuration settings

Description

Allows the developer to get the configuration settings for the application

onConfigLoaded

• onConfigLoaded: (handler: EventHandlerFunction) => void

Type declaration

• (handler): void

Parameters

Name	Type
handler	EventHandlerFunction

Returns

void

Description

Allows the developer to register a callback to be triggered when all configurations have been consolidated

setConfig

• setConfig: (config: ConfigSettings) => void

Type declaration

• (config): void

Parameters

Name	Type	Description
config	ConfigSettings	An object of configuration settings to be set

Returns

void

Description

Allows the developer to set a configuration setting for the application