@backstage/config-loader
Home > @backstage/config-loader
Config loading functionality used by Backstage backend, and CLI
Classes
Class |
Description |
---|---|
A collection of utilities for working with and creating ConfigSources. | |
A config source that reads configuration from the environment. | |
A config source that loads configuration from a local file. | |
A config source that can be updated with new data. | |
A config source that loads configuration from a remote URL. | |
A configuration source that reads from a static object, promise, iterable, or observable. |
Functions
Function |
Description |
---|---|
Load configuration data. | |
Loads config schema for a Backstage instance. | |
Given a list of configuration schemas from packages, merge them into a single json schema. | |
Read runtime configuration from the environment. |
Interfaces
Interface |
Description |
---|---|
Common options for the default Backstage configuration sources. | |
A config implementation that can be closed. | |
A source of configuration data. | |
The data returned by ConfigSource.readConfigData(). | |
Options for ConfigSources.defaultForTargets(). | |
Options for ConfigSources.default(). | |
Options for EnvConfigSource.create(). | |
Options for FileConfigSource.create(). | |
Options for MutableConfigSource.create(). | |
Options for ConfigSource.readConfigData(). | |
Options for RemoteConfigSource.create(). | |
Options for StaticConfigSource.create(). |
Type Aliases
Type Alias |
Description |
---|---|
The the generator returned by ConfigSource.readConfigData(). | |
A loaded configuration schema that is ready to process configuration data. | |
Options used to process configuration data with a schema. | |
A target to read configuration from. | |
A type representing the possible configuration value visibilities | |
A custom function to be used for substitution withing configuration files. | |
Options that control the loading of configuration files in the backend. | |
Results of loading configuration files. | |
Options that control the loading of configuration schema files in the backend. | |
A custom function to be used for parsing configuration content. | |
A function used to transform primitive configuration values. The "path" in the context is a JQ-style path to the current value from within the original object passed to filterByVisibility(). For example, "field.list[2]" would refer to: { field: [ "foo", "bar", "baz" -- this one ] } |