SystemConfiguration

system. SystemConfiguration

Handles communication with the configuration endpoint. Can be used to get or set configuration options.

Constructor

new SystemConfiguration()

Source:

Methods

all(ignoreCacheopt) → {Promise}

Source:

Fetches all system configuration settings from the API and caches them so that future calls to this function won't call the API again.

Parameters:
Name Type Attributes Default Description
ignoreCache boolean <optional>
false

If set to true, calls the API regardless of cache status

Returns:

Promise that resolves with all the individual configuration options from the api.

Type
Promise

get(key, ignoreCacheopt) → {Promise}

Source:

Returns the value of the specified configuration option.

This is a convenience method that works exactly the same as calling configuration.all()[name].

Parameters:
Name Type Attributes Default Description
key String
ignoreCache boolean <optional>
false

If set to true, calls the API regardless of cache status

Returns:
Type
Promise