Class ConfigContainer

constructor

• new ConfigContainer(
      namespace?: string,
      initialSources?: AbstractConfigSource[],
  ): ConfigContainer

  Construct a new ConfigContainer.

  Parameters

  • namespace: string = '@default'

    Namespace or tool identifier (e.g. '@default', 'odoo', 'supabase').

  • initialSources: AbstractConfigSource[] = []

    Optional initial array of configuration sources.

  Returns ConfigContainer

Readonlynamespace

addSource

• addSource(source: AbstractConfigSource): this

  Registers an additional configuration source into this container. Sources are automatically sorted by priority descending.

  Parameters

  • source: AbstractConfigSource

    Configuration source provider.

  Returns this

  This container instance for fluent chaining.

get

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

  Retrieves a value across all sources by descending priority order.

  Type Parameters

  • T = unknown

  Parameters

  • path: string

    Property key or dot-notation path.

  • Optionalfallback: T

    Optional fallback value if not found.

  Returns T | undefined

  The resolved value or fallback.

getBoolean

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

  Retrieves an optional boolean parameter.

  Parameters

  • path: string
  • Optionalfallback: boolean

  Returns boolean | undefined

getNumber

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

  Retrieves an optional number parameter.

  Parameters

  • path: string
  • Optionalfallback: number

  Returns number | undefined

getString

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

  Retrieves an optional string parameter.

  Parameters

  • path: string
  • Optionalfallback: string

  Returns string | undefined

has

• has(path: string): boolean

  Checks whether a value exists across any registered source.

  Parameters

  • path: string

    Property key or dot-notation path.

  Returns boolean

  True if defined in at least one source.

require

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

  Requires a parameter to exist and not be null or empty string. Throws ConfigurationError immediately on missing values (Fail-Fast).

  Type Parameters

  • T = unknown

  Parameters

  • path: string

    Property key or dot-notation path.

  • OptionalhelpText: string

    Optional remediation guidance.

  Returns T

  The resolved value typed as T.

  Throws

  If parameter is missing or empty string.

requireArray

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

  Requires an array parameter (Fail-Fast).

  Type Parameters

  • T = unknown

  Parameters

  • path: string

    Property key or dot-notation path.

  • OptionalhelpText: string

    Optional remediation guidance.

  Returns T[]

  The resolved array.

requireBoolean

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

  Requires a boolean parameter (Fail-Fast). Accepts true, false, "true", "false", "1", "0".

  Parameters

  • path: string

    Property key or dot-notation path.

  • OptionalhelpText: string

    Optional remediation guidance.

  Returns boolean

  The resolved boolean.

requireEnum

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

  Requires a value matching an allowed set of enum values (Fail-Fast).

  Type Parameters

  • T extends string

  Parameters

  • path: string

    Property key or dot-notation path.

  • allowedValues: readonly T[]

    Array of allowed string constants.

  • OptionalhelpText: string

    Optional remediation guidance.

  Returns T

  The validated enum string.

requireNumber

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

  Requires a numeric parameter (Fail-Fast). Supports string representations of numbers (e.g. "8080" -> 8080).

  Parameters

  • path: string

    Property key or dot-notation path.

  • OptionalhelpText: string

    Optional remediation guidance.

  Returns number

  The resolved number.

requireString

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

  Requires a non-empty string parameter (Fail-Fast).

  Parameters

  • path: string

    Property key or dot-notation path.

  • OptionalhelpText: string

    Optional remediation guidance.

  Returns string

  The resolved trimmed string.

scope

• scope(subPath: string): ConfigContainer

  Creates a scoped sub-container focused on a specific sub-path. Accesses to 'port' in scope('api') automatically query 'api.port'.

  Parameters

  • subPath: string

    Dot-notation prefix path.

  Returns ConfigContainer

  A new ConfigContainer scoped to the subPath.

set

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

  Sets a configuration value directly in the highest-priority memory store.

  Parameters

  • path: string

    Property key or dot-notation path.

  • value: unknown

    Value to set.

  Returns void

toRecord

• toRecord(): Record<string, unknown>

  Collapses all sources into a single merged key-value record snapshot.

  Returns Record<string, unknown>