Interface FileConfigProviderOptions<T>

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

Type Parameters

  • T = unknown

Hierarchy

  • ConfigProviderOptions<T>
    • FileConfigProviderOptions

Properties

schema? cache? cacheTTL? prefix? watch? transformers? files optional?

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

files

files: string[]

Array of file paths to load (in order of priority) Later files override earlier ones

Optionaloptional

optional?: boolean

Skip files that don't exist instead of throwing error

Default

false

Settings

Member Visibility

On This Page

Properties