Documentation
¶
Index ¶
- func ParseBoolFromEnv(envVar string, defaultValue bool) bool
- func ParseDurationFromEnv(env string, defaultValue, minimum, maximum time.Duration) time.Duration
- func ParseFloat64FromEnv(env string, defaultValue, minimum, maximum float64) float64
- func ParseFloatFromEnv(env string, defaultValue, minimum, maximum float32) float32
- func ParseInt64FromEnv(env string, defaultValue, minimum, maximum int64) int64
- func ParseNumFromEnv(env string, defaultValue, minimum, maximum int) int
- func ParseStringToStringFromEnv(envVar string, defaultValue map[string]string, separator string) map[string]string
- func StringFromEnv(env string, defaultValue string, opts ...StringFromEnvOpts) string
- func StringsFromEnv(env string, defaultValue []string, separator string) []string
- type StringFromEnvOpts
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ParseBoolFromEnv ¶
ParseBoolFromEnv retrieves a boolean value from given environment envVar. Returns default value if envVar is not set.
nolint:unparam
func ParseDurationFromEnv ¶
Helper function to parse a time duration from an environment variable. Returns a default if env is not set, is not parseable to a duration, exceeds maximum (if maximum is greater than 0) or is less than minimum.
nolint:unparam
func ParseFloat64FromEnv ¶
Helper function to parse a float64 from an environment variable. Returns a default if env is not set, is not parseable to a number, exceeds maximum (if maximum is greater than 0) or is less than minimum (and minimum is greater than 0).
func ParseFloatFromEnv ¶
Helper function to parse a float32 from an environment variable. Returns a default if env is not set, is not parseable to a number, exceeds maximum (if maximum is greater than 0) or is less than minimum (and minimum is greater than 0).
func ParseInt64FromEnv ¶
Helper function to parse a int64 from an environment variable. Returns a default if env is not set, is not parseable to a number, exceeds maximum (if maximum is greater than 0) or is less than minimum.
func ParseNumFromEnv ¶
Helper function to parse a number from an environment variable. Returns a default if env is not set, is not parseable to a number, exceeds maximum (if maximum is greater than 0) or is less than minimum.
func ParseStringToStringFromEnv ¶
func ParseStringToStringFromEnv(envVar string, defaultValue map[string]string, separator string) map[string]string
ParseStringToStringFromEnv parses given value from the environment as a map of string. Returns default value if envVar is not set.
func StringFromEnv ¶
func StringFromEnv(env string, defaultValue string, opts ...StringFromEnvOpts) string
func StringsFromEnv ¶
StringsFromEnv parses given value from the environment as a list of strings, using separator as the delimeter, and returns them as a slice. The strings in the returned slice will have leading and trailing white space removed.
Types ¶
type StringFromEnvOpts ¶
type StringFromEnvOpts struct {
// AllowEmpty allows the value to be empty as long as the environment variable is set.
AllowEmpty bool
}
Source Files