env

Documentation

Overview

Package env provides functionality to dynamically load the environment variables

Note: This is just a modified copy and wrapper around the gotenv package by suboisto

Index

• Variables
• func Apply(r io.Reader) error
• func Environ() []string
• func Expand(v string, env Env) (string, error)
• func ExpandAll(v interface{}, env Env) error
• func Getenv(key string) string
• func Load(filenames ...string) error
• func LoadFiles(files ...string)
• func LookupEnv(key string) (string, bool)
• func Must(fn func(filenames ...string) error, filenames ...string)
• func OverApply(r io.Reader) error
• func OverLoad(filenames ...string) error
• type Env
  • func EnvironMap() Env
  • func Parse(r io.Reader) Env
  • func ParseFiles(files ...string) Env
  • func StrictParse(r io.Reader) (Env, error)
  • func (env Env) Expand() error
  • func (env Env) Slice() []string

Variables

var (
	ErrUnknownVariable = fmt.Errorf("unknown variable")
	ErrCyclicVariable  = fmt.Errorf("cyclic variable")
)

var Files = []string{"ntt.env", "k3.env"}

Functions

func Apply

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 Environ

func Environ() []string

Environ returns the current process's environment as a string-slice of the form key=value. It also replaces K3-prefixes with NTT-prefixes.

func Expand

func Expand(v string, env Env) (string, error)

Expand expands variable references recursively.

func ExpandAll

func ExpandAll(v interface{}, env Env) error

func Getenv

func Getenv(key string) string

Lookup key in process environment. Is key begins with "NTT_" also lookup key with "K3_" prefix.

func Load

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 LoadFiles

func LoadFiles(files ...string)

LoadFiles environment files ntt.env and k3.env

func LookupEnv

func LookupEnv(key string) (string, bool)

LookupEnv is like Getenv, but returns a true boolean when key exists

func Must

func Must(fn func(filenames ...string) error, filenames ...string)

Must is wrapper function that will panic when supplied function returns an error.

func OverApply

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

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.

Types

type Env

type Env map[string]string

Env holds key/value pair of valid environment variable

func EnvironMap

func EnvironMap() Env

EnvironMap returns the current process's environment as a string-map. It also replaces K3-prefixes with NTT-prefixes.

func Parse

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 ParseFiles

func ParseFiles(files ...string) Env

ParseFiles environment files ntt.env and k3.env

func StrictParse

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.

func (Env) Expand

func (env Env) Expand() error

Expand variable references recursively. Environment variables overwrite variables defined in environment files. Undefined variables won't be expanded and will return an error.

func (Env) Slice

func (env Env) Slice() []string

Slice returns a sorted string slice of the variables.