ConfigReader
Home > @backstage/config
> ConfigReader
An implementation of the Config
interface that uses a plain JavaScript object for the backing data, with the ability of linking multiple readers together.
Signature:
class ConfigReader implements Config
Implements: Config
Constructors
Constructor |
Modifiers |
Description |
---|---|---|
Constructs a new instance of the |
Methods
Method |
Modifiers |
Description |
---|---|---|
|
Instantiates the config reader from a list of application config objects. | |
Same as | ||
Same as | ||
Same as | ||
Same as | ||
Same as | ||
Read out all configuration data for the given key. Usage of this method should be avoided as the typed alternatives provide much better error reporting. The main use-case of this method is to determine the type of a configuration value in the case where there are multiple possible shapes of the configuration. | ||
Reads a configuration value at the given key, expecting it to be a boolean. | ||
Creates a sub-view of the configuration object. The configuration value at the position of the provided key must be an object. | ||
Creates a sub-view of an array of configuration objects. The configuration value at the position of the provided key must be an array of objects. | ||
Reads a configuration value at the given key, expecting it to be a number. | ||
Reads a configuration value at the given key, expecting it to be a string. | ||
Reads a configuration value at the given key, expecting it to be an array of strings. | ||
Same as | ||
Same as | ||
Checks whether the given key is present. | ||
Lists all available configuration keys. |