Type Alias RequiredEnvEntry<Value>

Required environment entry

Since

v1.1.0

type RequiredEnvEntry<Value> = {
    defaultValue: Loadable<Value>;
    params?: FormatParameters;
    parser: IConfigParser<unknown, Value>;
    undefinedErrorMessage?: string;
    undefinedThrowsError?: boolean;
}

Type Parameters

Value
type of value

Index

Properties

defaultValue params? parser undefinedErrorMessage? undefinedThrowsError?

Properties

defaultValue

defaultValue: Loadable<Value>

The default value to use if the variable is not defined

`Optional`params

params?: FormatParameters

The format parameters to use to format the value

parser

parser: IConfigParser<unknown, Value>

The parser to use to parse the value

`Optional`undefinedErrorMessage

undefinedErrorMessage?: string

Replaces the default throw error message with this message

`Optional`undefinedThrowsError

undefinedThrowsError?: boolean

Whether to throw an error if the variable is undefined