config

Documentation

Index

• type Config
  • func New() (Config, error)
  • func (c *Config) Load() (io.Reader, error)
• type ErrUndefinedConfig
  • func (e *ErrUndefinedConfig) Error() string

Types

type Config

type Config struct {
	Addr       string  `env:"ADDR" envDefault:"0.0.0.0:8080"`
	ConfigPath string  `env:"CONFIG_PATH"`
	ConfigURL  url.URL `env:"CONFIG_URL"`
}

Config stores configuration parameters for interacting with the server at a global level. This can include listening address, feature flags and other configurations.

func New

func New() (Config, error)

New initializes a Config, attempting to parse parames from Envs.

func (*Config) Load

func (c *Config) Load() (io.Reader, error)

Load attempts to fetch a Router configuration from one of the optional locations (URL or Filepath). On success it returns an io.Reader for this file otherwise an error is returned.

type ErrUndefinedConfig

type ErrUndefinedConfig struct{}

ErrUndefinedConfig represents a route configuration hasn't been specified.

func (*ErrUndefinedConfig) Error

func (e *ErrUndefinedConfig) Error() string