envs

Documentation

Index

• Variables
• func ExistEnv(key string) bool
• func ExpandValueEnv(value string) (realValue string)
• func ExpandValueEnvForMap(m map[string]interface{}) map[string]interface{}
• func GetEnv(e ...string) string
• func Home() string
• func Init() (err error)
• func IsDebug() bool
• func IsDev() bool
• func IsProd() bool
• func IsSkipErrorFile() bool
• func IsStag() bool
• func LoadFile(envFiles ...string) (err error)
• func Parse() map[string]string
• func SetDebug() error
• func SetEnv(e, v string) error
• func SetSkipErrorFile() error

Variables

var Cfg = struct {
	Prefix string
	Home   string
	Env    string
}{
	Prefix: "",
	Home:   "",
	Env:    DevEnv.Dev,
}

Cfg default config

var DevEnv = _Env{
	Dev:  "dev",
	Stag: "stag",
	Prod: "prod",
}

DevEnv program environment

Functions

func ExistEnv

func ExistEnv(key string) bool

ExistEnv check if the environment variable is defined

func ExpandValueEnv

func ExpandValueEnv(value string) (realValue string)

ExpandValueEnv returns value of convert with environment variable.

Return environment variable if value start with "${" and end with "}". Return default value if environment variable is empty or not exist.

It accept value formats "${env}" , "${env||}}" , "${env||defaultValue}" , "defaultvalue". Examples:

v1 := config.ExpandValueEnv("${GOPATH}")			// return the GOPATH environment variable.
v2 := config.ExpandValueEnv("${GOAsta||/usr/local/go}")	// return the default value "/usr/local/go/".
v3 := config.ExpandValueEnv("Astaxie")				// return the value "Astaxie".

func ExpandValueEnvForMap

func ExpandValueEnvForMap(m map[string]interface{}) map[string]interface{}

ExpandValueEnvForMap convert all string value with environment variable.

func GetEnv

func GetEnv(e ...string) string

GetEnv get environment variable with prefix

func Home

func Home() string

Home get home config path

func Init

func Init() (err error)

Init init environment

func IsDebug

func IsDebug() bool

IsDebug 是否是debug模式

func IsDev

func IsDev() bool

IsDev 是否是dev模式

func IsProd

func IsProd() bool

IsProd 是否是prod模式

func IsSkipErrorFile

func IsSkipErrorFile() bool

IsSkipErrorFile 是否跳过错误文件

func IsStag

func IsStag() bool

IsStag 是否是stag模式

func LoadFile

func LoadFile(envFiles ...string) (err error)

LoadFile 加载.env文件并添加前缀

func Parse

func Parse() map[string]string

Parse 解析envs map[string]string

func SetDebug

func SetDebug() error

SetDebug 设置debug模式

func SetEnv

func SetEnv(e, v string) error

SetEnv set environment variable with prefix

func SetSkipErrorFile

func SetSkipErrorFile() error

SetSkipErrorFile 设置跳过错误