config

Documentation

Overview

Package config contains viper config initialisation method.

Index

• Variables
• func Init(opts *app.Options) error
• func WatchVariable(key string, cb WatcherCallback) error
• type Config
• type StubConfig
  • func (c StubConfig) Get(key string) Value
  • func (c StubConfig) WatchVariable(key string, cb WatcherCallback) error
• type Value
  • func Get(key string) Value
• type ViperConfig
  • func NewViperConfig(opts *app.Options) (*ViperConfig, error)
  • func (c *ViperConfig) Get(key string) Value
  • func (c *ViperConfig) WatchVariable(key string, cb WatcherCallback) error
• type WatcherCallback

Variables

var (
	ErrConfigNotInitialized = errors.New("config not initialized")
	ErrEmptyKey             = errors.New("key is empty")
)

Config errors.

Functions

func Init

func Init(opts *app.Options) error

Init initialise viper config.

func WatchVariable

func WatchVariable(key string, cb WatcherCallback) error

WatchVariable allows to set a callback func on a specific variable change.

Types

type Config

type Config interface {
	Get(key string) Value
	WatchVariable(key string, cb WatcherCallback) error
}

Config describes a config client.

type StubConfig

type StubConfig struct{}

StubConfig implements Config.

func (StubConfig) Get

func (c StubConfig) Get(key string) Value

Get returns nilValue.

func (StubConfig) WatchVariable

func (c StubConfig) WatchVariable(key string, cb WatcherCallback) error

WatchVariable returns ErrConfigNotInitialized.

type Value

type Value interface {
	IsNil() bool
	String() string
	Bool() bool
	Int() int
	Int32() int32
	Int64() int64
	Uint() uint
	Uint32() uint32
	Uint64() uint64
	Float64() float64
	Time() time.Time
	Duration() time.Duration
	IntSlice() []int
	StringSlice() []string
	StringMap() map[string]interface{}
	StringMapString() map[string]string
}

Value describes a config value.

func Get

func Get(key string) Value

Get returns a config Value associated with the key.

type ViperConfig

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

ViperConfig implements Config interface for values.yaml.

func NewViperConfig

func NewViperConfig(opts *app.Options) (*ViperConfig, error)

NewViperConfig returns new viper config instance.

func (*ViperConfig) Get

func (c *ViperConfig) Get(key string) Value

Get returns a config Value associated with the key in viper config.

func (*ViperConfig) WatchVariable

func (c *ViperConfig) WatchVariable(key string, cb WatcherCallback) error

WatchVariable allows to set a callback func on a specific variable change in viper config.

type WatcherCallback

type WatcherCallback func(oldValue, newValue Value)

WatcherCallback is a callback function for a variable watcher.