Interface ConfigValueFunc

interface ConfigValueFunc {
    (envVarName): undefined | string;
    (envVarName, defaultOrRequired): string;
    (envVarName, validator): undefined | string;
    (envVarName, required, validator): string;
    (envVarName, defaultValue, validator): string;
    (envVarName, t): undefined | string;
    (envVarName, t, defaultOrRequired): string;
    (envVarName, t, validator): undefined | string;
    (envVarName, t, required, validator): string;
    (envVarName, t, defaultValue, validator): string;
    (envVarName, t): undefined | number | `::ERROR::${string}`;
    (envVarName, t, defaultOrRequired): number | `::ERROR::${string}`;
    (envVarName, t, validator): number | `::ERROR::${string}`;
    (envVarName, t, required, validator): number | `::ERROR::${string}`;
    (envVarName, t, defaultValue, validator): number | `::ERROR::${string}`;
    (envVarName, t): undefined | boolean | `::ERROR::${string}`;
    (envVarName, t, defaultOrRequired): boolean | `::ERROR::${string}`;
    (envVarName, t, validator): undefined | boolean | `::ERROR::${string}`;
    (envVarName, t, required, validator): boolean | `::ERROR::${string}`;
    (envVarName, t, defaultValue, validator): boolean | `::ERROR::${string}`;
    <T>(envVarName, t): undefined | `::ERROR::${string}` | T;
    <T>(envVarName, t, defaultOrRequired): `::ERROR::${string}` | T;
    <T>(envVarName, t, validator): undefined | `::ERROR::${string}` | T;
    <T>(envVarName, t, required, validator): `::ERROR::${string}` | T;
    <T>(envVarName, t, defaultValue, validator): `::ERROR::${string}` | T;
}
  • Parameters

    • envVarName: string | string[]

    Returns undefined | string

  • Parameters

    • envVarName: string | string[]
    • defaultOrRequired: DefOrReq<string>

    Returns string

  • Parameters

    • envVarName: string | string[]
    • validator: ValidatorArg<string>

    Returns undefined | string

  • Parameters

    • envVarName: string | string[]
    • required: typeof REQUIRED
    • validator: ValidatorArg<string>

    Returns string

  • Parameters

    • envVarName: string | string[]
    • defaultValue: string
    • validator: ValidatorArg<string>

    Returns string

  • Parameters

    • envVarName: string | string[]
    • t: "str"

    Returns undefined | string

  • Parameters

    • envVarName: string | string[]
    • t: "str"
    • defaultOrRequired: DefOrReq<string>

    Returns string

  • Parameters

    • envVarName: string | string[]
    • t: "str"
    • validator: ValidatorArg<string>

    Returns undefined | string

  • Parameters

    • envVarName: string | string[]
    • t: "str"
    • required: typeof REQUIRED
    • validator: ValidatorArg<string>

    Returns string

  • Parameters

    • envVarName: string | string[]
    • t: "str"
    • defaultValue: string
    • validator: ValidatorArg<string>

    Returns string

  • Parameters

    • envVarName: string | string[]
    • t: "num"

    Returns undefined | number | `::ERROR::${string}`

  • Parameters

    • envVarName: string | string[]
    • t: "num"
    • defaultOrRequired: DefOrReq<number>

    Returns number | `::ERROR::${string}`

  • Parameters

    • envVarName: string | string[]
    • t: "num"
    • validator: ValidatorArg<number>

    Returns number | `::ERROR::${string}`

  • Parameters

    • envVarName: string | string[]
    • t: "num"
    • required: typeof REQUIRED
    • validator: ValidatorArg<number>

    Returns number | `::ERROR::${string}`

  • Parameters

    • envVarName: string | string[]
    • t: "num"
    • defaultValue: number
    • validator: ValidatorArg<number>

    Returns number | `::ERROR::${string}`

  • Parameters

    • envVarName: string | string[]
    • t: "bool"

    Returns undefined | boolean | `::ERROR::${string}`

  • Parameters

    • envVarName: string | string[]
    • t: "bool"
    • defaultOrRequired: DefOrReq<boolean>

    Returns boolean | `::ERROR::${string}`

  • Parameters

    • envVarName: string | string[]
    • t: "bool"
    • validator: ValidatorArg<boolean>

    Returns undefined | boolean | `::ERROR::${string}`

  • Parameters

    • envVarName: string | string[]
    • t: "bool"
    • required: typeof REQUIRED
    • validator: ValidatorArg<boolean>

    Returns boolean | `::ERROR::${string}`

  • Parameters

    • envVarName: string | string[]
    • t: "bool"
    • defaultValue: boolean
    • validator: ValidatorArg<boolean>

    Returns boolean | `::ERROR::${string}`

  • Type Parameters

    • T

    Parameters

    Returns undefined | `::ERROR::${string}` | T

  • Type Parameters

    • T

    Parameters

    • envVarName: string | string[]
    • t: Transformer<T>
    • defaultOrRequired: DefOrReq<T>

    Returns `::ERROR::${string}` | T

  • Type Parameters

    • T

    Parameters

    • envVarName: string | string[]
    • t: Transformer<T>
    • validator: ValidatorArg<T>

    Returns undefined | `::ERROR::${string}` | T

  • Type Parameters

    • T

    Parameters

    Returns `::ERROR::${string}` | T

  • Type Parameters

    • T

    Parameters

    • envVarName: string | string[]
    • t: Transformer<T>
    • defaultValue: T
    • validator: ValidatorArg<T>

    Returns `::ERROR::${string}` | T

Generated using TypeDoc