Class FileConfigProvider

File-based configuration provider

Loads configuration from JSON and YAML files with support for:

  • Multiple files with merge
  • Hot reload with file watchers
  • Validation with schemas
  • Environment-specific overrides

Example

const config = new FileConfigProvider({
  files: [
    './config/default.json',
    './config/production.json',
  ],
  watch: true,
});

// Watch for changes
config.watch?.((changes) => {
  console.log('Config changed:', changes);
});

Implements

  • ConfigProvider

Constructors

constructor

Methods

get getRequired getAll getNamespace has reload watch

Constructors

constructor

Methods

get

  • get<T = unknown>(key: string, defaultValue?: T): Promise<undefined | T>

    Get a configuration value with optional type and default

    Type Parameters

    • T = unknown

    Parameters

    • key: string

      The configuration key (supports dot notation: 'database.url')

    • OptionaldefaultValue: T

      Default value if key is not found

    Returns Promise<undefined | T>

    The configuration value or default

    Example

    const port = await config.get<number>('server.port', 3000);
    const timeout = await config.get<number>('api.timeout', 5000);

getRequired

  • getRequired<T = unknown>(key: string): Promise<T>

    Get a required configuration value

    Type Parameters

    • T = unknown

    Parameters

    • key: string

      The configuration key

    Returns Promise<T>

    The configuration value

    Throws

    ConfigNotFoundError if the value is not found

    Example

    const apiKey = await config.getRequired<string>('api.key');

getAll

  • getAll<T = Record<string, unknown>>(): Promise<T>

    Get all configuration as an object

    Type Parameters

    • T = Record<string, unknown>

    Returns Promise<T>

    The complete configuration object

    Example

    const allConfig = await config.getAll<AppConfig>();

getNamespace

  • getNamespace<T = Record<string, unknown>>(namespace: string): Promise<T>

    Get configuration for a specific namespace

    Type Parameters

    • T = Record<string, unknown>

    Parameters

    • namespace: string

      The namespace key (e.g., 'database', 'server')

    Returns Promise<T>

    Configuration object for the namespace

    Example

    const dbConfig = await config.getNamespace('database');
    // Returns: { url: '...', poolSize: 10, ... }

has

  • has(key: string): Promise<boolean>

    Check if a configuration key exists

    Parameters

    • key: string

      The configuration key

    Returns Promise<boolean>

    True if the key exists, false otherwise

    Example

    if (await config.has('features.newUI')) {
      // Feature flag exists
    }

reload

  • reload(): Promise<void>

    Reload configuration (if supported by implementation)

    Returns Promise<void>

    Example

    await config.reload();
    console.log('Configuration reloaded');

watch

  • watch(callback: WatchCallback): () => void

    Watch for configuration changes (if supported)

    Parameters

    • callback: WatchCallback

      Function called when configuration changes

    Returns () => void

    Function to unsubscribe from changes

    Example

    const unwatch = config.watch?.((changes) => {
      for (const change of changes) {
        console.log(`${change.key} changed from ${change.oldValue} to ${change.newValue}`);
      }
    });

    // Later: stop watching
    unwatch?.();

Settings

Member Visibility

On This Page

Constructors
Methods