config_loader

package

v0.3.1 Latest Latest Go to latest Published: Dec 4, 2023 License: MIT Imports: 9 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

This section is empty.

This section is empty.

func Load(config Configuration, options ...ConfigOption) error

Load loads the configuration from the given config file.

Rules:

- The config file must be either a JSON or YAML file.

- All fields must be exported.

- Fields without env tag will be uppercase and used as environment variable name.

type ConfigOption func(*LoaderOpts)

func ConfigPath(path string) ConfigOption

ConfigPath sets the path to the config file.

func EnvFileName(envFileName string) ConfigOption

EnvFileName sets the name of the .env file, defaults to .env

func EnvPrefix(prefix string) ConfigOption

EnvPrefix sets the prefix for environment variables. Will capitalize the prefix.

func ErrorIfNotFound(errorIfNotFound bool) ConfigOption

ErrorIfNotFound sets the flag that determines whether an error should be returned if the config file is not found.

func RootDir(rootDir string) ConfigOption

RootDir sets the directory to look for .env files

type Configuration any

type LoaderOpts struct {
	// contains filtered or unexported fields
}

LoaderOpts is a struct that contains options for the config loader.