configutils

package module

v0.0.0-...-ea9fa95 Latest Latest Go to latest Published: May 20, 2024 License: MIT Imports: 8 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/koofr/go-configutils

Links

Open Source Insights

README ¶

go-configutils

Go config utils.

Install

go get github.com/koofr/go-configutils

Testing

go test

Documentation ¶

Index ¶

func DisableEnvOverride() func(*LoadConfigOptions)
func EnvGetter(envGetter envigo.EnvGetter) func(*LoadConfigOptions)
func EnvPrefix(envPrefix string) func(*LoadConfigOptions)
func LoadConfig(configFile string, config interface{}, optFuncs ...func(*LoadConfigOptions)) (err error)
func LoadConfigBytes(configFileBytes []byte, config interface{}, ...) (err error)
func LoadConfigFile(configFile string, config interface{}) (err error)
func OverrideConfigBytes(configBytes []byte) func(*LoadConfigOptions)
func OverrideConfigFile(configFile string) func(*LoadConfigOptions)
func YAMLKeepRootKeys(b []byte, keys ...string) []byte
func YAMLPatchBytes(patch func(b []byte) []byte) func(*LoadConfigOptions)
func YAMLRemoveRootKeys(b []byte, keys ...string) []byte
func YAMLValidateKeys(validate bool) func(*LoadConfigOptions)
type LoadConfigOptions

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DisableEnvOverride ¶

func DisableEnvOverride() func(*LoadConfigOptions)

func EnvGetter ¶

func EnvGetter(envGetter envigo.EnvGetter) func(*LoadConfigOptions)

func EnvPrefix ¶

func EnvPrefix(envPrefix string) func(*LoadConfigOptions)

func LoadConfig ¶

func LoadConfig(configFile string, config interface{}, optFuncs ...func(*LoadConfigOptions)) (err error)

func LoadConfigBytes ¶

func LoadConfigBytes(configFileBytes []byte, config interface{}, optFuncs ...func(*LoadConfigOptions)) (err error)

func LoadConfigFile ¶

func LoadConfigFile(configFile string, config interface{}) (err error)

func OverrideConfigBytes ¶

func OverrideConfigBytes(configBytes []byte) func(*LoadConfigOptions)

func OverrideConfigFile ¶

func OverrideConfigFile(configFile string) func(*LoadConfigOptions)

func YAMLKeepRootKeys ¶

func YAMLKeepRootKeys(b []byte, keys ...string) []byte

func YAMLPatchBytes ¶

func YAMLPatchBytes(patch func(b []byte) []byte) func(*LoadConfigOptions)

func YAMLRemoveRootKeys ¶

func YAMLRemoveRootKeys(b []byte, keys ...string) []byte

func YAMLValidateKeys ¶

func YAMLValidateKeys(validate bool) func(*LoadConfigOptions)

Types ¶

type LoadConfigOptions ¶

type LoadConfigOptions struct {
	EnvOverride         bool
	EnvPrefix           string
	EnvGetter           envigo.EnvGetter
	OverrideConfigFiles []string
	OverrideConfigBytes [][]byte
	YAMLValidateKeys    bool
	YAMLPatchBytes      func(b []byte) []byte
}

Source Files ¶

View all Source files

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