Documentation ¶
Overview ¶
Package gotenv provides functionality to dynamically load the environment variables
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Apply ¶ added in v1.0.0
Apply is function to load an io Reader then export the valid variables into environment variables if they are not exist.
func Load ¶
Load is function to load a file or multiple files and then export the valid variables into environment variables if they are not exists. When it's called with no argument, it will load `.env` file on the current path and set the environment variables. Otherwise, it will loop over the filenames parameter and set the proper environment variables.
func MustLoad ¶ added in v1.0.0
func MustLoad(filenames ...string)
MustLoad is similar function like Load but will panic when supplied files are not exist.
func MustOverLoad ¶ added in v1.0.0
func MustOverLoad(filenames ...string)
MustOverLoad is similar function like OverLoad but will panic when supplied files are not exist.
Types ¶
type Env ¶
Env holds key/value pair of valid environment variable
func Parse ¶
Parse is a function to parse line by line any io.Reader supplied and returns the valid Env key/value pair of valid variables. It expands the value of a variable from environment variable, but does not set the value to the environment itself. This function is skipping any invalid lines and only processing the valid one.
Example ¶
package main import ( "fmt" "github.com/subosito/gotenv" "strings" ) func main() { pairs := gotenv.Parse(strings.NewReader("FOO=test\nBAR=$FOO")) fmt.Printf("%+v\n", pairs) // gotenv.Env{"FOO": "test", "BAR": "test"} pairs = gotenv.Parse(strings.NewReader(`FOO="bar"`)) fmt.Printf("%+v\n", pairs) // gotenv.Env{"FOO": "bar"} }
Output:
func StrictParse ¶ added in v1.0.0
StrictParse is a function to parse line by line any io.Reader supplied and returns the valid Env key/value pair of valid variables. It expands the value of a variable from environment variable, but does not set the value to the environment itself. This function is returning an error if there is any invalid lines.