env

Documentation

Index

• Constants
• Variables
• type Environ
  • func NewEnviron(prefix service.Name) Environ
• type Environment
  • func Env(environ Environ) Environment
  • func Local() Environment
  • func Production() Environment
  • func Test() Environment
  • func (e Environment) IsLocal() bool
  • func (e Environment) IsProduction() bool
  • func (e Environment) IsTest() bool
  • func (e Environment) Load(files ...string)
  • func (e Environment) String() string

Constants

const EnvironmentKey = "ENVIRONMENT"

EnvironmentKey is the environment variable we look for to set the environment (prefixed with service name)

Variables

var Module = fx.Module(
	"env",
	fx.Provide(
		Env,
		NewEnviron,
	),
)

Types

type Environ

type Environ interface {
	Getenv(key string) string
}

func NewEnviron

func NewEnviron(prefix service.Name) Environ

type Environment

type Environment string

Environment is a defined environment

func Env

func Env(environ Environ) Environment

Env returns the environment from the environment variables

func Local

func Local() Environment

func Production

func Production() Environment

func Test

func Test() Environment

func (Environment) IsLocal

func (e Environment) IsLocal() bool

IsLocal returns true if the environment is not defined (aka local)

func (Environment) IsProduction

func (e Environment) IsProduction() bool

IsProduction returns true if the environment is the production environment.

func (Environment) IsTest

func (e Environment) IsTest() bool

IsTest returns true if the environment is the test environment

func (Environment) Load

func (e Environment) Load(files ...string)

Load loads the environment variables from the specified files and from the standard locations

func (Environment) String

func (e Environment) String() string

String returns a string version of the environment.