Interface ConfigBuilder

Fluent builder for creating a Config instance.

interface ConfigBuilder {
    build(): Config;
    withConverter<R extends object>(
        cls: ClassConstructor<R>,
        priority: number,
        converter: Converter<R>,
    ): ConfigBuilder;
    withDefaultConverters(): ConfigBuilder;
    withDefaultSources(): ConfigBuilder;
    withMergeSourceValues(mergeSourceValues: boolean): ConfigBuilder;
    withSources(...sources: ConfigSource[]): ConfigBuilder;
}

Implemented by

LayeredConfigBuilder

Index

Methods

build withConverter withDefaultConverters withDefaultSources withMergeSourceValues withSources

Methods

build

build(): Config
Builds a Config instance and registers it with the ConfigProvider.

Returns Config
The built configuration instance.

Throws
ConfigurationError if a configuration has already been registered.
- Defined in src/data/configuration/api/config-builder.ts:60

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
The ConfigBuilder instance for method chaining.
- Defined in src/data/configuration/api/config-builder.ts:42

withDefaultConverters

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

Returns ConfigBuilder
The ConfigBuilder instance for method chaining.
- Defined in src/data/configuration/api/config-builder.ts:24

withDefaultSources

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

Returns ConfigBuilder
The ConfigBuilder instance for method chaining.
- Defined in src/data/configuration/api/config-builder.ts:17

withMergeSourceValues

withMergeSourceValues(mergeSourceValues: boolean): ConfigBuilder
Sets whether to merge source values. If true, the values from an objects properties if defined will be used to merge into a final instance. If false, the values from the source with the highest ordinal will be used if the object from that source is defined, even it is properties are not defined.
Parameters
- mergeSourceValues: boolean
  Whether to merge source values.
Returns ConfigBuilder
The ConfigBuilder instance for method chaining.
- Defined in src/data/configuration/api/config-builder.ts:52

withSources

withSources(...sources: ConfigSource[]): ConfigBuilder
Adds the specified configuration sources to the configuration.
Parameters
- ...sources: ConfigSource[]
  The configuration sources to be added.
Returns ConfigBuilder
The ConfigBuilder instance for method chaining.
- Defined in src/data/configuration/api/config-builder.ts:32