package gotenv

Import Path
	github.com/subosito/gotenv (on go.dev)

Dependency Relation
	imports 6 packages, and imported by one package

Involved Source Files

	   d➜ gotenv.go
		Package gotenv provides functionality to dynamically load the environment variables
Package-Level Type Names (only one, which is exported)

	/* sort exporteds by: alphabet | popularity */
	 type Env (map)
		Env holds key/value pair of valid environment variable

		As Outputs Of (at least 2, both are exported)
			func Parse(r io.Reader) Env
			func StrictParse(r io.Reader) (Env, error)
		As Inputs Of (at least 5, none are exported)
			/* 5+ unexporteds ... *//* 5+ unexporteds: */
			func checkFormat(s string, env Env) error
			func parseExport(st string, env Env) error
			func parseLine(s string, env Env) error
			func parseVal(val string, env Env) string
			func varReplacement(s string, hsq bool, env Env) string


Package-Level Functions (total 15, in which 7 are exported)

	 func Apply(r io.Reader) error
		Apply is a function to load an io Reader then export the valid variables into environment variables if they do not exist.

	 func Load(filenames ...string) error
		Load is a function to load a file or multiple files and then export the valid variables into environment variables if they do not exist.
		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 Must(fn func(filenames ...string) error, filenames ...string)
		Must is wrapper function that will panic when supplied function returns an error.

	 func OverApply(r io.Reader) error
		OverApply is a function to load an io Reader then export and override the valid variables into environment variables.

	 func OverLoad(filenames ...string) error
		OverLoad is a function to load a file or multiple files and then export and override the valid variables into environment variables.

	 func Parse(r io.Reader) Env
		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 the 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.

	 func StrictParse(r io.Reader) (Env, error)
		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 the environment variable but does not set the value to the environment itself.
		This function is returning an error if there are any invalid lines.

	/* 8 unexporteds ... *//* 8 unexporteds: */
	 func checkFormat(s string, env Env) error
	 func loadenv(override bool, filenames ...string) error
	 func parseExport(st string, env Env) error
	 func parseLine(s string, env Env) error
	 func parset(r io.Reader, override bool) error
		parse and set :)

	 func parseVal(val string, env Env) string
	 func setenv(key, val string, override bool)
	 func varReplacement(s string, hsq bool, env Env) string
Package-Level Constants (total 2, neither is exported)

	/* 2 unexporteds ... *//* 2 unexporteds: */
	const linePattern = "\\A\\s*(?:export\\s+)?([\\w\\.]+)(?:\\s*=\\s*|:\\s+?)('(?:\\'|[^'])*...
		Pattern for detecting valid line format

	const variablePattern = "(\\\\)?(\\$)(\\{?([A-Z0-9_]+)?\\}?)"
		Pattern for detecting valid variable within a value

The pages are generated with Golds v0.3.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.