config

Documentation

Index

• type Config
  • func New(name string, dirs ...string) (c *Config)
  • func (c *Config) Load() (err error)
  • func (c *Config) Register(name string, o Options)
  • func (c *Config) String() string
  • func (c *Config) VerifyAndPrepare() error
• type Options

Types

type Config

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

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

New creates a new instance of Config.

func (*Config) Load

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

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

func (*Config) Register

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

Register adds new Options to the Config.

func (*Config) String

func (c *Config) String() string

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

func (*Config) VerifyAndPrepare

func (c *Config) VerifyAndPrepare() error

VerifyAndPrepare executes the same named method on options in config.

type Options

type Options interface {
	VerifyAndPrepare() error
}

Options defines methods that are required for options.