env

Documentation

Index

• func Defined(keys ...string) bool
• func Getenv(key string) string
• func WithStubbedEnv(stubs Stubs, block func())
• type Env
  • func New() Env
• type Stubs

Functions

func Defined

func Defined(keys ...string) bool

Helper method for quickly check if envs are present

func Getenv

func Getenv(key string) string

Helper method for quickly accessing environment variables

func WithStubbedEnv

func WithStubbedEnv(stubs Stubs, block func())

Used mostly in tests, allows you to stub environment for testing

Types

type Env

type Env interface {
	Getenv(key string) string
	LookupEnv(key string) (string, bool)
}

Env interface describes env objects used for environment variables lookup

func New

func New() Env

Create a new environment accessor

type Stubs

type Stubs map[string]string

Stubs that allow you to define key -> value of an environment variable