Interface CompositeConfigProviderOptions<T>

interface CompositeConfigProviderOptions<T = unknown> {
    schema?: ConfigSchema<T>;
    cache?: boolean;
    cacheTTL?: number;
    prefix?: string;
    watch?: boolean;
    transformers?: Record<string, (value: string) => unknown>;
    providers: ConfigProvider[];
    strategy?: MergeStrategy;
}

Type Parameters

  • T = unknown

Hierarchy

  • ConfigProviderOptions<T>
    • CompositeConfigProviderOptions

Properties

schema? cache? cacheTTL? prefix? watch? transformers? providers strategy?

Properties

Optionalschema

schema?: ConfigSchema<T>

Validation schema (optional)

Optionalcache

cache?: boolean

Cache configuration values

Default

true

OptionalcacheTTL

cacheTTL?: number

Cache TTL in milliseconds

Default

undefined (no expiration)

Optionalprefix

prefix?: string

Prefix for all keys

Optionalwatch

watch?: boolean

Enable hot reload (if supported)

Default

false

Optionaltransformers

transformers?: Record<string, (value: string) => unknown>

Transformation functions for specific keys

Example

{
  transformers: {
    'port': (value) => parseInt(value, 10),
    'timeout': (value) => parseInt(value, 10),
  }
}

providers

providers: ConfigProvider[]

Array of config providers (in priority order) For 'first-wins': earlier providers have higher priority For 'last-wins': later providers have higher priority For 'merge': all providers are merged

Optionalstrategy

strategy?: MergeStrategy

Merge strategy for combining values from multiple providers

  • 'first-wins': First provider with the value wins (default)
  • 'last-wins': Last provider with the value wins
  • 'merge': Deep merge objects from all providers

Default

'first-wins'

Settings

Member Visibility

On This Page

Properties