config

Documentation

Index

• type Config
• type DefaultConfig
  • func (d *DefaultConfig) Optional(key string, defaultValue string) string
  • func (d *DefaultConfig) Required(key string) (string, error)
• type FakeConfig
  • func NewFakeConfig() *FakeConfig
  • func (t *FakeConfig) Optional(key string, defaultValue string) string
  • func (t *FakeConfig) Required(key string) (string, error)
  • func (t *FakeConfig) Set(key string, value string)

Types

type Config

type Config interface {
	// Get an optional setting by name, with a default value to return if it does
	// exist.
	Optional(key string, defaultValue string) string

	// Get a required setting by name.
	Required(key string) (string, error)
}

Interface for fetching configuration settings

type DefaultConfig

type DefaultConfig struct {
}

The default configuration implementation simply fetches a setting from an environment variable.

func (*DefaultConfig) Optional

func (d *DefaultConfig) Optional(key string, defaultValue string) string

func (*DefaultConfig) Required

func (d *DefaultConfig) Required(key string) (string, error)

type FakeConfig

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

func NewFakeConfig

func NewFakeConfig() *FakeConfig

func (*FakeConfig) Optional

func (t *FakeConfig) Optional(key string, defaultValue string) string

func (*FakeConfig) Required

func (t *FakeConfig) Required(key string) (string, error)

func (*FakeConfig) Set

func (t *FakeConfig) Set(key string, value string)