env

package

v1.2.0 Latest Latest Go to latest Published: Oct 15, 2023 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Excoriate/golang-cli-boilerplate

Links

Open Source Insights

Documentation ¶

Index ¶

func GetBoolOrDefault(key string, defaultValue bool) bool
func GetDurationOrDefault(key string, defaultValue time.Duration) time.Duration
func GetEnvVarsFromDotFile(opt DotEnvFileReadOpt) (map[string]string, error)
func GetNumberInt64OrDefault(key string, defaultValue int64) int64
func GetNumberOrDefault(key string, defaultValue int) int
func GetSliceOrDefault(key string, defaultValue []string) []string
func GetStringOrDefault(key, defaultValue string) string
func IsSet(key string) error
func MergeEnvVars(envVars ...map[string]string) map[string]string
func ScanAWSEnvVarsFromHost() (types.EnvVars, error)
func ScanEnvVarsFromHost() (types.EnvVars, error)
func ScanEnvVarsWithPrefix(prefix string) (types.EnvVars, error)
func ScanTerraformEnvVarsFromHost() (types.EnvVars, error)
func SetEnvVars(envVars types.EnvVars) error
type DotEnv
- func (d *DotEnv) LoadByEnv(env string) error
- func (d *DotEnv) LoadByName(dotEnvFileName string) error
type DotEnvFileReadOpt
type DotEnvLoader
- func NewDotEnv() DotEnvLoader
type MockedUtils
- func (m *MockedUtils) FileExistAndIsAFileMock(filename string) error
type VarSkeleton
- func GetFromMultiplePotentialKeys(keysAllowed []string) (VarSkeleton, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GetBoolOrDefault ¶

func GetBoolOrDefault(key string, defaultValue bool) bool

GetBoolOrDefault CreateWebRoute boolean value from Viper by given key.

func GetDurationOrDefault ¶

func GetDurationOrDefault(key string, defaultValue time.Duration) time.Duration

GetDurationOrDefault CreateWebRoute duration value from Viper by given key.

func GetEnvVarsFromDotFile ¶

func GetEnvVarsFromDotFile(opt DotEnvFileReadOpt) (map[string]string, error)

func GetNumberInt64OrDefault ¶ added in v1.1.0

func GetNumberInt64OrDefault(key string, defaultValue int64) int64

func GetNumberOrDefault ¶

func GetNumberOrDefault(key string, defaultValue int) int

GetNumberOrDefault CreateWebRoute number value from Viper by given key.

func GetSliceOrDefault ¶ added in v1.1.0

func GetSliceOrDefault(key string, defaultValue []string) []string

func GetStringOrDefault ¶

func GetStringOrDefault(key, defaultValue string) string

GetStringOrDefault CreateWebRoute string value from Viper by given key.

func IsSet ¶ added in v1.1.0

func IsSet(key string) error

func MergeEnvVars ¶

func MergeEnvVars(envVars ...map[string]string) map[string]string

func ScanAWSEnvVarsFromHost ¶

func ScanAWSEnvVarsFromHost() (types.EnvVars, error)

func ScanEnvVarsFromHost ¶

func ScanEnvVarsFromHost() (types.EnvVars, error)

ScanEnvVarsFromHost CreateWebRoute all env vars.

func ScanEnvVarsWithPrefix ¶

func ScanEnvVarsWithPrefix(prefix string) (types.EnvVars, error)

ScanEnvVarsWithPrefix CreateWebRoute env vars with prefix. Returns an error if any of the variables either do not exist or have an empty value.

func ScanTerraformEnvVarsFromHost ¶

func ScanTerraformEnvVarsFromHost() (types.EnvVars, error)

func SetEnvVars ¶

func SetEnvVars(envVars types.EnvVars) error

Types ¶

type DotEnv ¶ added in v1.1.0

type DotEnv struct{}

func (*DotEnv) LoadByEnv ¶ added in v1.1.0

func (d *DotEnv) LoadByEnv(env string) error

func (*DotEnv) LoadByName ¶ added in v1.1.0

func (d *DotEnv) LoadByName(dotEnvFileName string) error

type DotEnvFileReadOpt ¶

type DotEnvFileReadOpt struct {
	FilePath       string
	IgnoreComments bool
}

type DotEnvLoader ¶ added in v1.1.0

type DotEnvLoader interface {
	LoadByEnv(env string) error
	LoadByName(dotEnvFileName string) error
}

func NewDotEnv ¶ added in v1.1.0

func NewDotEnv() DotEnvLoader

type MockedUtils ¶ added in v1.1.0

type MockedUtils struct {
	FileExistAndItIsAFile func(filename string) error
}

func (*MockedUtils) FileExistAndIsAFileMock ¶ added in v1.1.0

func (m *MockedUtils) FileExistAndIsAFileMock(filename string) error

type VarSkeleton ¶ added in v1.1.0

type VarSkeleton struct {
	Key   string
	Value string
}

func GetFromMultiplePotentialKeys ¶

func GetFromMultiplePotentialKeys(keysAllowed []string) (VarSkeleton, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL