Type Alias IEnvAccessor<TEnvConfig>

Type declaration

• get:function

  • get<
        TField extends string
        | number
        | symbol,
        TValue extends undefined | string | number | boolean,
    >(
        field: TField,
    ): UndefinedToNull<TValue>

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

    Type Parameters

    • TField extends string | number | symbol
    • TValue extends undefined | string | number | boolean

    Parameters

    • field: TField

      The env field to retrieve.

    Returns UndefinedToNull<TValue>

    The value or null if not present.

    Throws

    If called before initialization.

• getOr:function

  • getOr<
        TField extends string
        | number
        | symbol,
        TValue extends undefined | string | number | boolean,
    >(
        field: TField,
        defaultValue: NonNullable<TValue>,
    ): NonNullable<TValue>

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

    Type Parameters

    • TField extends string | number | symbol
    • TValue extends undefined | string | number | boolean

    Parameters

    • field: TField

      The env field to retrieve.
    • defaultValue: NonNullable<TValue>

      The default value when not found.

    Returns NonNullable<TValue>

    The value or default value.

    Throws

    If called before initialization.