Interface ConfigProvider

The ConfigProvider interface provides the ability to build, register, access, and release a Config instance.

interface ConfigProvider {
    builder(): ConfigBuilder;
    config(): Config;
    register(config: Config): void;
    release(): void;
}

Implemented by

LayeredConfigProvider

Index

Methods

builder config register release

Methods

builder

builder(): ConfigBuilder
Creates a new configuration instance. The configuration built by this builder is not registered with the provider by the ConfigBuilder#build method. Callers should use the ConfigProvider#register method to register the configuration with the provider.

Returns ConfigBuilder
A new configuration builder instance.
- Defined in src/data/configuration/api/config-provider.ts:40

config

config(): Config
Retrieves the current configuration.

Returns Config
The current configuration.

Throws
Error if the configuration has not been registered.
- Defined in src/data/configuration/api/config-provider.ts:16

register

register(config: Config): void
Registers the specified configuration with the provider.
Parameters
- config: Config
  The configuration to be registered.
Returns void
Throws
ConfigurationError if a configuration has already been registered.
- Defined in src/data/configuration/api/config-provider.ts:24

release

release(): void
Releases the configuration that is currently registered with the provider.

Returns void
Throws
ConfigurationError if a configuration has not been registered.
- Defined in src/data/configuration/api/config-provider.ts:31