Skip to content
@archipel/platform-configuration Auto-generated

@breadstone/archipel-platform-configuration

Classes

ClassDescription
ConfigKeyNotFoundErrorError thrown when a configuration key cannot be resolved.
ConfigModuleThe ConfigModule class.
ConfigRegistryA static, global registry that collects all configuration keys registered by platform libraries. This enables a central overview of every environment variable the application depends on, grouped by source module.
ConfigService-
ConfigStrategyBaseThe ConfigStrategyBase class. Represents the base class for configuration strategies.
EnvironmentConfigStrategyThe EnvironmentConfigStrategy class.
FileConfigStrategyThe FileConfigStrategy class.

Interfaces

InterfaceDescription
IConfigKeyA type-safe config key that encodes both the config key and the type of its value.
IConfigModuleOptionsThe IConfigModuleOptions interface.
IConfigRegistryEntryDescribes a registered configuration entry, including its source module and whether the entry is required or optional (with a default value).

Functions

FunctionDescription
createConfigKeyCreates a type-safe config key.

Released under the MIT License.