Documentation
¶
Index ¶
- type DotEnv
- func (obj DotEnv) Exec(filenames []string, cmd string, cmdArgs []string) error
- func (o DotEnv) GetBool(key string, defaultVal string, errMsgRequired string) bool
- func (obj DotEnv) GetEnv(key string) utils.UtilString
- func (o DotEnv) GetFloat(key string, defaultVal string, errMsgRequired string) float64
- func (o DotEnv) GetInt(key string, defaultVal string, errMsgRequired string) int32
- func (o DotEnv) GetInt16(key string, defaultVal string, errMsgRequired string) int16
- func (o DotEnv) GetInt64(key string, defaultVal string, errMsgRequired string) int64
- func (o DotEnv) GetString(key string, defaultVal string, errMsgRequired string) string
- func (o DotEnv) GetStringArray(key string, sep string, errMsgRequired string) []string
- func (o DotEnv) GetUint(key string, defaultVal string, errMsgRequired string) uint32
- func (o DotEnv) GetUint16(key string, defaultVal string, errMsgRequired string) uint16
- func (o DotEnv) GetUint64(key string, defaultVal string, errMsgRequired string) uint64
- func (obj DotEnv) Load(filenames ...string) (err error)
- func (obj DotEnv) Marshal(envMap map[string]string) (string, error)
- func (obj DotEnv) Overload(filenames ...string) (err error)
- func (obj DotEnv) Parse(r io.Reader) (envMap map[string]string, err error)
- func (obj DotEnv) Read(filenames ...string) (envMap map[string]string, err error)
- func (obj DotEnv) Unmarshal(str string) (envMap map[string]string, err error)
- func (obj DotEnv) Write(envMap map[string]string, filename string) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DotEnv ¶
type DotEnv struct {
}
func (DotEnv) Exec ¶
Exec loads env vars from the specified filenames (empty map falls back to default) then executes the cmd specified.
Simply hooks up os.Stdin/err/out to the command and calls Run()
If you want more fine grained control over your command it's recommended that you use `Load()` or `Read()` and the `os/exec` package yourself.
func (DotEnv) GetStringArray ¶
func (DotEnv) Load ¶
Load will read your env file(s) and load them into ENV for this process.
Call this function as close as possible to the start of your program (ideally in main)
If you call Load without any args it will default to loading .env in the current path ¶
You can otherwise tell it which files to load (there can be more than one) like
godotenv.Load("fileone", "filetwo")
It's important to note that it WILL NOT OVERRIDE an env variable that already exists - consider the .env file to set dev vars or sensible defaults
func (DotEnv) Marshal ¶
Marshal outputs the given environment as a dotenv-formatted environment file. Each line is in the format: KEY="VALUE" where VALUE is backslash-escaped.
func (DotEnv) Overload ¶
Overload will read your env file(s) and load them into ENV for this process.
Call this function as close as possible to the start of your program (ideally in main)
If you call Overload without any args it will default to loading .env in the current path ¶
You can otherwise tell it which files to load (there can be more than one) like
godotenv.Overload("fileone", "filetwo")
It's important to note this WILL OVERRIDE an env variable that already exists - consider the .env file to forcefilly set all vars.
func (DotEnv) Read ¶
Read all env (with same file loading semantics as Load) but return values as a map rather than automatically writing values into env