config

package

v0.0.0-...-bbcbdef Latest Latest Go to latest Published: Jun 9, 2023 License: Unlicense Imports: 11 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.

This section is empty.

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

Config is a type to mirror viper.Config, but with better custom type support. This stems from the closure of github.com/spf13/viper#271.

func New(opener Opener, name string, dirs ...string) (*Config, error)

New returns a Config for the given Config file name (without extension) and list of valid directories for that file to be found in.

func (c *Config) Get(k string) interface{}

Get gets the value at k. If the default value has been set using SetDefault, the data will be converted to the same type as the default value.

func (c *Config) Keys() []string

Keys returns a list of all keys available in c.

func (c *Config) Set(k string, v interface{})

Set sets the value at k.

func (c *Config) SetDefault(k string, v interface{})

SetDefault sets the type and the default value for the data at k.

func (c *Config) Write() error

Write writes c to the path it was opened from, or the most preferred path path otherwise.

type Opener interface {
	Open(path string) (f io.ReadCloser, err error)
	Create(path string) (f io.WriteCloser, err error)
}

Opener is a type which can read files.