Class LayeredConfigProvider

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

Implements

ConfigProvider

Index

Constructors

Methods

builder config register release

Constructors

constructor

new LayeredConfigProvider(
mapper: ObjectMapper,
prefix?: string,
): LayeredConfigProvider
Parameters
- mapper: ObjectMapper
- Optionalprefix: string
Returns LayeredConfigProvider
- Defined in src/data/configuration/impl/layered-config-provider.ts:17

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.
Implementation of ConfigProvider.builder
- Defined in src/data/configuration/impl/layered-config-provider.ts:24

config

config(): Config
Retrieves the current configuration.

Returns Config
The current configuration.

Throws
Error if the configuration has not been registered.
Implementation of ConfigProvider.config
- Defined in src/data/configuration/impl/layered-config-provider.ts:28

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.
Implementation of ConfigProvider.register
- Defined in src/data/configuration/impl/layered-config-provider.ts:36

release

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

Returns void
Throws
ConfigurationError if a configuration has not been registered.
Implementation of ConfigProvider.release
- Defined in src/data/configuration/impl/layered-config-provider.ts:48