Interface EnvConfigProviderOptions<T>

interface EnvConfigProviderOptions<T = unknown> {
    schema?: ConfigSchema<T>;
    cache?: boolean;
    cacheTTL?: number;
    prefix?: string;
    watch?: boolean;
    transformers?: Record<string, (value: string) => unknown>;
    loadDotenv?: boolean;
    dotenvPath?: string;
    autoTransform?: boolean;
    env?: Record<string, undefined | string>;
}

Type Parameters

  • T = unknown

Hierarchy

  • ConfigProviderOptions<T>
    • EnvConfigProviderOptions

Properties

schema? cache? cacheTTL? prefix? watch? transformers? loadDotenv? dotenvPath? autoTransform? env?

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

OptionalloadDotenv

loadDotenv?: boolean

Load .env file

Default

true

OptionaldotenvPath

dotenvPath?: string

Path to .env file

Default

'.env'

OptionalautoTransform

autoTransform?: boolean

Enable auto-transformation of values (string -> number, boolean, etc.)

Default

true

Optionalenv

env?: Record<string, undefined | string>

Environment object to read from

Default

process.env

Settings

Member Visibility

On This Page

Properties