env

Documentation

Index

• Constants
• func AppEnvironment() string
• func Get(key, fallback string) string
• func GetOrError(key string) (string, error)
• func IsDevelopment() bool
• func IsProduction() bool
• func IsStaging() bool
• func ParseConfig(cfg any, filenames ...string) error

Constants

const (
	// Development env definition.
	Development string = "development"
	// Staging env definition.
	Staging = "staging"
	// Production env definition.
	Production = "production"
)

Environment definitions.

const (
	// AppEnvironmentKey is the key for the app environment, i.e. prod/dev
	AppEnvironmentKey = "APP_ENV"
)

Common keys

Functions

func AppEnvironment

func AppEnvironment() string

AppEnvironment returns the app environment.

func Get

func Get(key, fallback string) string

Get provides a default override for environment vars as a second argument.

func GetOrError

func GetOrError(key string) (string, error)

GetOrError will attempt to get the value from the environment variable and return an error if not available.

func IsDevelopment

func IsDevelopment() bool

IsDevelopment returns whether we are running the app in development.

func IsProduction

func IsProduction() bool

IsProduction returns whether we are running the app in production.

func IsStaging

func IsStaging() bool

IsStaging returns whether we are running the app in staging.

func ParseConfig

func ParseConfig(cfg any, filenames ...string) error

ParseConfig loads the environment variables from the .env file and parses the environment variables into the provided struct. It returns an error if the .env file cannot be loaded or if the environment variables cannot be parsed.\

For example:

type Config struct {
	Home         string         `env:"HOME"`
	Port         int            `env:"PORT" envDefault:"3000"`
	Password     string         `env:"PASSWORD,unset"`
	IsProduction bool           `env:"PRODUCTION"`
	Duration     time.Duration  `env:"DURATION"`
	Hosts        []string       `env:"HOSTS" envSeparator:":"`
	TempFolder   string         `env:"TEMP_FOLDER,expand" envDefault:"${HOME}/tmp"`
	StringInts   map[string]int `env:"MAP_STRING_INT"`
}