environment

Documentation

Overview

Package environment implements functions to read values from environment variables of the OS.

Index

• func GetEnv(key string, defaultVal string) string
• func GetEnvBool(key string, defaultVal bool) bool
• func GetEnvFloat32(key string, defaultVal float32) float32
• func GetEnvFloat64(key string, defaultVal float64) float64
• func GetEnvInt(key string, defaultVal int) int
• func GetEnvMap(prefix string, cutoffPrefix bool) map[string]string

Functions

func GetEnv

func GetEnv(key string, defaultVal string) string

GetEnv reads a string value from the environment with the given key. If the key is not found, the default value is returned.

func GetEnvBool

func GetEnvBool(key string, defaultVal bool) bool

GetEnvBool reads a string value from the environment with the given key and returns it as bool. If the key is not found or is not a bool, the default value is returned.

func GetEnvFloat32

func GetEnvFloat32(key string, defaultVal float32) float32

GetEnvFloat32 reads a string value from the environment with the given key and returns it as float32. If the key is not found or is not a float32, the default value is returned.

func GetEnvFloat64

func GetEnvFloat64(key string, defaultVal float64) float64

GetEnvFloat64 reads a string value from the environment with the given key and returns it as float64. If the key is not found or is not a float64, the default value is returned.

func GetEnvInt

func GetEnvInt(key string, defaultVal int) int

GetEnvInt reads a string value from the environment with the given key and returns it as int. If the key is not found or is not a int, the default value is returned.

func GetEnvMap

func GetEnvMap(prefix string, cutoffPrefix bool) map[string]string

GetEnvMap reads all environment variables with the given prefix. (CAUTION!! Auto attaches the "_" character!!)

It returns a map with all env variables found.