envparser

Documentation

Index

• Variables
• func ErrorIsEnvVarEmpty(err error) bool
• func ErrorIsInvalidVarName(err error) bool
• func GetEnvBool(key string) (bool, error)
• func GetEnvBoolWithDefault(key string, defaultValue bool) bool
• func GetEnvFloat64(key string) (float64, error)
• func GetEnvFloat64WithDefault(key string, defaultValue float64) float64
• func GetEnvInt(key string) (int, error)
• func GetEnvIntWithDefault(key string, defaultValue int) int
• func GetEnvString(key string) (string, error)
• func GetEnvStringWithDefault(key string, defaultValue string) string
• func MustGetEnvBool(key string) bool
• func MustGetEnvFloat64(key string) float64
• func MustGetEnvInt(key string) int
• func MustGetEnvString(key string) string
• func ValidateKeyName(key string) bool
• type ErrorWrapper
  • func (e *ErrorWrapper) Error() string
  • func (e *ErrorWrapper) Unwrap() error

Variables

var (
	ErrEnvVarEmpty    = errors.New("environment variable empty")
	ErrInvalidVarName = errors.New("invalid variable name")
)

var IsLetter = regexp.MustCompile(pattern).MatchString

Functions

func ErrorIsEnvVarEmpty

func ErrorIsEnvVarEmpty(err error) bool

ErrorIsEnvVarEmpty return true if error is same with ErrEnvVarEmpty

func ErrorIsInvalidVarName

func ErrorIsInvalidVarName(err error) bool

ErrorIsInvalidVarName return true if error is same with ErrInvalidVarName

func GetEnvBool

func GetEnvBool(key string) (bool, error)

GetEnvBool return value of env variable. Value will be set to false and error will be returned if env variable failed to parse

func GetEnvBoolWithDefault

func GetEnvBoolWithDefault(key string, defaultValue bool) bool

GetEnvBoolWithDefault return value of env variable if any or return default value if error

func GetEnvFloat64

func GetEnvFloat64(key string) (float64, error)

GetEnvFloat64 return value of env variable. Value will be set to 0.0 and error will be returned if env variable failed to parse

func GetEnvFloat64WithDefault

func GetEnvFloat64WithDefault(key string, defaultValue float64) float64

GetEnvFloat64WithDefault return value of env variable if any or return default value if error

func GetEnvInt

func GetEnvInt(key string) (int, error)

GetEnvInt return value of env variable. Value will be set to 0 and error will be returned if env variable failed to parse

func GetEnvIntWithDefault

func GetEnvIntWithDefault(key string, defaultValue int) int

GetEnvIntWithDefault return value of env variable if any or return default value if error

func GetEnvString

func GetEnvString(key string) (string, error)

GetEnvStr return value of env variable. Not null error returned if env variable is empty string

func GetEnvStringWithDefault

func GetEnvStringWithDefault(key string, defaultValue string) string

GetEnvStringWithDefault return value of env variable if any or return default value if error

func MustGetEnvBool

func MustGetEnvBool(key string) bool

MustGetEnvBool return value of env variable if any or throw panic if blank or failed to parse variable

func MustGetEnvFloat64

func MustGetEnvFloat64(key string) float64

MustGetEnvFloat64 return value of env variable if any or throw panic if blank or failed to parse variable

func MustGetEnvInt

func MustGetEnvInt(key string) int

MustGetEnvInt return value of env variable if any or throw panic if blank or failed to parse variable

func MustGetEnvString

func MustGetEnvString(key string) string

MustGetEnvStr return value of env variable if any or throw panic if blank or failed to parse variable

func ValidateKeyName

func ValidateKeyName(key string) bool

ValidateKeyName must ensure env variable name only contain alphanumeric + underscore return true if env variable name is valid otherwise return false

Types

type ErrorWrapper

type ErrorWrapper struct {
	KeyName string
	Err     error
}

func (*ErrorWrapper) Error

func (e *ErrorWrapper) Error() string

func (*ErrorWrapper) Unwrap

func (e *ErrorWrapper) Unwrap() error