Class Config

constructor

• new Config(): Config

  Returns Config

Static Readonlylogger

StaticdefaultConfig

• get defaultConfig(): string

  The alias of the currently active default configuration container.

  Returns string

• set defaultConfig(alias: string): void

  Parameters

  • alias: string

  Returns void

StaticaddConfig

• addConfig(
      alias: string,
      dataOrSource?:
          | AbstractConfigSource
          | Record<string, unknown>
          | ConfigContainer,
      setDefault?: boolean,
  ): ConfigContainer

  Registers a new or existing configuration container under a specific alias.

  Parameters

  • alias: string

    Short identifier name (e.g. 'odoo', 'google-drive', 'supabase').

  • OptionaldataOrSource: AbstractConfigSource | Record<string, unknown> | ConfigContainer

    Object data, custom AbstractConfigSource, or ConfigContainer.

  • setDefault: boolean = false

    Whether to set this alias as the default target.

  Returns ConfigContainer

  The registered ConfigContainer.

Staticclear

• clear(): void

  Clears all registered configurations and resets the default alias. Useful for isolating unit tests.

  Returns void

Staticget

• get<T = unknown>(path: string, fallback?: T, alias?: string): T | undefined

  Retrieves a value from the default container.

  Type Parameters

  • T = unknown

  Parameters

  • path: string
  • Optionalfallback: T
  • alias: string = ...

  Returns T | undefined

StaticgetBoolean

• getBoolean(
      path: string,
      fallback?: boolean,
      alias?: string,
  ): boolean | undefined

  Retrieves an optional boolean on the default container.

  Parameters

  • path: string
  • Optionalfallback: boolean
  • alias: string = ...

  Returns boolean | undefined

StaticgetConfig

• getConfig(alias?: string): ConfigContainer

  Retrieves an existing configuration container by alias. If the default alias is requested but not yet registered, an automatic default container wired to environment variables is initialized.

  Parameters

  • alias: string = ...

    Target alias identifier. Defaults to defaultConfig ('@default').

  Returns ConfigContainer

  The resolved ConfigContainer.

  Throws

  If a custom alias is requested but not registered.

StaticgetNumber

• getNumber(path: string, fallback?: number, alias?: string): number | undefined

  Retrieves an optional number on the default container.

  Parameters

  • path: string
  • Optionalfallback: number
  • alias: string = ...

  Returns number | undefined

StaticgetString

• getString(path: string, fallback?: string, alias?: string): string | undefined

  Retrieves an optional string on the default container.

  Parameters

  • path: string
  • Optionalfallback: string
  • alias: string = ...

  Returns string | undefined

StatichasConfig

• hasConfig(alias: string): boolean

  Checks if a configuration alias is currently registered.

  Parameters

  • alias: string

    Target alias identifier.

  Returns boolean

StaticremoveConfig

• removeConfig(alias: string): boolean

  Removes a registered configuration container from the registry.

  Parameters

  • alias: string

    Target alias identifier.

  Returns boolean

  True if the container was removed.

Staticrequire

• require<T = unknown>(path: string, helpText?: string, alias?: string): T

  Requires a parameter on the default container (Fail-Fast).

  Type Parameters

  • T = unknown

  Parameters

  • path: string
  • OptionalhelpText: string
  • alias: string = ...

  Returns T

StaticrequireArray

• requireArray<T = unknown>(path: string, helpText?: string, alias?: string): T[]

  Requires an array on the default container (Fail-Fast).

  Type Parameters

  • T = unknown

  Parameters

  • path: string
  • OptionalhelpText: string
  • alias: string = ...

  Returns T[]

StaticrequireBoolean

• requireBoolean(path: string, helpText?: string, alias?: string): boolean

  Requires a boolean on the default container (Fail-Fast).

  Parameters

  • path: string
  • OptionalhelpText: string
  • alias: string = ...

  Returns boolean

StaticrequireEnum

• requireEnum<T extends string>(
      path: string,
      allowedValues: readonly T[],
      helpText?: string,
      alias?: string,
  ): T

  Requires an enum value on the default container (Fail-Fast).

  Type Parameters

  • T extends string

  Parameters

  • path: string
  • allowedValues: readonly T[]
  • OptionalhelpText: string
  • alias: string = ...

  Returns T

StaticrequireNumber

• requireNumber(path: string, helpText?: string, alias?: string): number

  Requires a number on the default container (Fail-Fast).

  Parameters

  • path: string
  • OptionalhelpText: string
  • alias: string = ...

  Returns number

StaticrequireString

• requireString(path: string, helpText?: string, alias?: string): string

  Requires a non-empty string on the default container (Fail-Fast).

  Parameters

  • path: string
  • OptionalhelpText: string
  • alias: string = ...

  Returns string

Staticscope

• scope(aliasOrPath: string): ConfigContainer

  Accesses a fine-grained configuration scope. If alias exists directly in the registry, returns that container. Otherwise, resolves a sub-scope on the default container.

  Parameters

  • aliasOrPath: string

    Registered namespace alias or dot-notation path.

  Returns ConfigContainer

  Scoped ConfigContainer.

Staticset

• set(path: string, value: unknown, alias?: string): void

  Sets a configuration value on the default container.

  Parameters

  • path: string
  • value: unknown
  • alias: string = ...

  Returns void