SolarNetwork Core

Class: Configuration

util~ Configuration

A configuration utility object.

Properties can be get/set by using the module:util~Configuration#value function.

new Configuration(initialMap)

Constructor.

For any properties passed on initialMap, module:util~Configuration#value will be called so those properties are defined on this instance.

Parameters:
Name Type Description
initialMap object

the optional initial properties to store

Methods

enabled(key)

Test if a key is truthy.

Parameters:
Name Type Description
key string

the key to test
Returns:

true if the key is enabled

Type
boolean

toggle(key, enabled)

Set or toggle the enabled status of a given key.

If the enabled parameter is not passed, then the enabled status will be toggled to its opposite value.

Parameters:
Name Type Description
key string

they key to set
enabled boolean

the optional enabled value to set
Returns:

this object to allow method chaining

Type
module:util~Configuration

value(key [, newValue])

Get or set a configuration value.

Parameters:
Name Type Argument Description
key string

The key to get or set the value for
newValue object <optional>

If defined, the new value to set for the given key. If null then the value will be removed.
Returns:

If called as a getter, the associated value for the given key, otherwise this object.

Type
object

values( [newMap])

Get or set multiple properties.

Parameters:
Name Type Argument Description
newMap object <optional>

a map of values to set
Returns:

if called as a getter, all properties of this object copied into a simple object; otherwise this object

Type
object