Type Alias RequiredEnvEntry<Value>

RequiredEnvEntry: {
    defaultValue: Loadable<Value>;
    loaders: IConfigLoader[];
    params?: FormatParameters;
    parser: IConfigParser<Value, unknown>;
    undefinedErrorMessage?: string;
    undefinedThrowsError?: boolean;
}

Required environment entry

Type Parameters

  • Value

Type declaration

  • defaultValue: Loadable<Value>

    The default value to use if the variable is not defined

  • loaders: IConfigLoader[]

    The loaders to use to load the value

  • Optionalparams?: FormatParameters

    The format parameters to use to format the value

  • parser: IConfigParser<Value, unknown>

    The parser to use to parse the value

  • OptionalundefinedErrorMessage?: string

    Replaces the default throw error message with this message

  • OptionalundefinedThrowsError?: boolean

    Whether to throw an error if the variable is undefined

Since

v0.8.0

Settings

Member Visibility