configutil

Documentation

Overview

Package configutil contains methods for loading and reading from configuration files, and for reading 'dotenv' files.

Index

• Constants
• func GoEnv() string
• func LoadEnv(filenames ...string) error
• func LookupGoEnv() (string, bool)
• func NewViper(name, namespace string) *viper.Viper
• func UnmarshalViper(v *viper.Viper, ptr zero.Interface, opts ...viper.DecoderConfigOption) error

Constants

const (
	EnvProduction  = "production"
	EnvDevelopment = "development"
)

Well-known values for 'GOENV'.

const GoEnvKey = "GOENV"

GoEnvKey is the key for the environmant variable that describes the current environment (i.e. "production", "development").

Functions

func GoEnv

func GoEnv() string

GoEnv reteurns the current environment value for 'GOENV'.

func LoadEnv

func LoadEnv(filenames ...string) error

LoadEnv attempts to loads environment variables from 'dotenv' files, as specified by filenames. If no filenames are given, it will attempt to read '.env' and '.env.local' in the current directory.

It will attempt to load environment variables from all the files in filenames, and will skip missing files.

func LookupGoEnv

func LookupGoEnv() (string, bool)

LookupGoEnv is like GetEnv, except it additionally returns true if 'GOENV' was set, and false otherwise.

func NewViper

func NewViper(name, namespace string) *viper.Viper

NewViper creates a new Viper that reads from a config file with the provided name, set in a namespace.

func UnmarshalViper

func UnmarshalViper(
	v *viper.Viper,
	ptr zero.Interface,
	opts ...viper.DecoderConfigOption,
) error

UnmarshalViper unmarshals the configuration data in viper.Viper into the value pointed to by ptr.