Type Alias IConfigAccessor<TConfig>

Type declaration

• get:function

  • get<TPath extends string>(path: TPath): PathValue<TConfig, TPath>

  • Get a value from the config, or null if missing/undefined.

    Type Parameters

    • TPath extends string

    Parameters

    • path: TPath

      The config value path to retrieve.

    Returns PathValue<TConfig, TPath>

    The value or null if not present.

• getOr:function

  • getOr<TPath extends string>(
        path: TPath,
        defaultValue: NonNullable<Get<TConfig, TPath>>,
    ): NonNullable<PathValue<TConfig, TPath>>

  • Get a value from the config, or return default value.

    Type Parameters

    • TPath extends string

    Parameters

    • path: TPath

      The config value path to retrieve.
    • defaultValue: NonNullable<Get<TConfig, TPath>>

      The default value when not found.

    Returns NonNullable<PathValue<TConfig, TPath>>

    The value or default value.