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;
    withSources(...sources: ConfigSource[]): ConfigBuilder;
}

Implemented by

LayeredConfigBuilder

Index

Methods

build withConverter withDefaultConverters withDefaultSources withSources

Methods

build

build(): Config
Builds a Config instance.

Returns Config
- Defined in src/data/configuration/api/config-builder.ts:41

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
- Defined in src/data/configuration/api/config-builder.ts:36

withDefaultConverters

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

Returns ConfigBuilder
- Defined in src/data/configuration/api/config-builder.ts:20

withDefaultSources

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

Returns ConfigBuilder
- Defined in src/data/configuration/api/config-builder.ts:15

withSources

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