Class LayeredConfigBuilder

Fluent builder for creating a Config instance.

Implements

ConfigBuilder

Index

Constructors

Methods

build withConverter withDefaultConverters withDefaultSources withSources

Constructors

constructor

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

Methods

build

build(): Config
Builds a Config instance.

Returns Config
Implementation of ConfigBuilder.build
- Defined in src/data/configuration/impl/layered-config-builder.ts:47

withConverter

withConverter<R extends object>(
    cls: ClassConstructor<R>,
    priority: number,
    converter: Converter<R>,
): ConfigBuilder
Adds the specified value converters to the configuration.
Type Parameters
- R extends object
Parameters
- cls: ClassConstructor<R>
  The class of the configuration to which the value should be converted.
- priority: number
  The priority of the configuration converter.
- converter: Converter<R>
  The configuration converter to be added.
Returns ConfigBuilder
Implementation of ConfigBuilder.withConverter
- Defined in src/data/configuration/impl/layered-config-builder.ts:29

withDefaultConverters

withDefaultConverters(): ConfigBuilder
Adds the default configuration converters to the configuration.

Returns ConfigBuilder
Implementation of ConfigBuilder.withDefaultConverters
- Defined in src/data/configuration/impl/layered-config-builder.ts:38

withDefaultSources

withDefaultSources(): ConfigBuilder
Adds the default configuration sources to the configuration.

Returns ConfigBuilder
Implementation of ConfigBuilder.withDefaultSources
- Defined in src/data/configuration/impl/layered-config-builder.ts:24

withSources

withSources(...sources: ConfigSource[]): ConfigBuilder
Adds the specified configuration sources to the configuration.
Parameters
- ...sources: ConfigSource[]
  The configuration sources to be added.
Returns ConfigBuilder
Implementation of ConfigBuilder.withSources
- Defined in src/data/configuration/impl/layered-config-builder.ts:42