env

Documentation

Index

• Constants
• func GetAllEnvs(filenames ...string) (map[string]string, error)
• func GetEnv(key string) (string, error)
• func GetEnvOrDefault(key, defaultVal string) string
• func LoadEnv(filenames ...string) error
• func ParseEnvBool(key string) (bool, error)
• func ParseEnvInt(key string) (int, error)
• func ParseEnvTimeDuration(key string) (time.Duration, error)

Constants

const (
	Dev     = "dev"
	Prod    = "prod"
	Staging = "staging"
)

Functions

func GetAllEnvs

func GetAllEnvs(filenames ...string) (map[string]string, error)

A wrapper func around godotenv read func, handling errors more precisely.

func GetEnv

func GetEnv(key string) (string, error)

A wrapper func around os.Getenv, but handles error with more text.

func GetEnvOrDefault

func GetEnvOrDefault(key, defaultVal string) string

Same as GetEnv, but with default value.

func LoadEnv

func LoadEnv(filenames ...string) error

Loads environment variables from the given files. It is intented to be used in development mode. If in dev mode, make sure to load the env vars first, then call other funcs.

func ParseEnvBool

func ParseEnvBool(key string) (bool, error)

Gets key's value, calling GetEnv and parses to bool. Assumes it is in a specific format - text or a binary representation.

func ParseEnvInt

func ParseEnvInt(key string) (int, error)

Gets and parses key's value to int.

func ParseEnvTimeDuration

func ParseEnvTimeDuration(key string) (time.Duration, error)

Gets and parses key's value to duration.