Interface ConfigProviderOptions<T>

Configuration provider options

interface ConfigProviderOptions<T = unknown> {
    schema?: ConfigSchema<T>;
    cache?: boolean;
    cacheTTL?: number;
    prefix?: string;
    watch?: boolean;
    transformers?: Record<string, (value: string) => unknown>;
}

Type Parameters

  • T = unknown

Properties

schema? cache? cacheTTL? prefix? watch? transformers?

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),
  }
}

Settings

Member Visibility

On This Page

Properties