config

package

v0.6.0 Latest Latest Go to latest Published: Jun 27, 2023 License: BSD-3-Clause Imports: 9 Imported by: 1

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.

This section is empty.

type Config struct {
	Name string
	Dirs []string
	// contains filtered or unexported fields
}

Config holds the common information for options: name and directories from where to load values.

func New(name string, dirs ...string) (c *Config)

New creates a new instance of Config.

func (c *Config) Load() (err error)

Load reads configuration values from json and yaml files in config directories, and also from environment variables.

func (c *Config) Register(name string, o Options)

Register adds new Options to the Config.

func (c *Config) String() string

String returns the YAML-encoded multi document representation of current configuration state.

func (c *Config) VerifyAndPrepare() error

VerifyAndPrepare executes the same named method on options in config.

type Options interface {
	VerifyAndPrepare() error
}

Options defines methods that are required for options.