config

Documentation

Index

• Constants
• Variables
• type Configuration
  • func NewConfigFromFile(file string) (config *Configuration, err error)
  • func (c *Configuration) IsEnvLocal() bool
  • func (c *Configuration) IsEnvProduction() bool
  • func (c *Configuration) IsEnvTesting() bool

Constants

const (
	EnvTesting    = "testing"
	EnvLocal      = "local"
	EnvProduction = "production"
)

Environment types.

Variables

var Config = &Configuration{}

Config is the global configuration instance.

Types

type Configuration

type Configuration struct {
	Hostname string `json:"hostname"`
	Port     uint32 `json:"port"`
	Database string `json:"database"`
	LogLevel string `json:"log_level"`
	Username string `json:"username"`
	Password string `json:"password"`

	Environment string `json:"environment"`
}

Configuration contains all configuration parameters.

func NewConfigFromFile

func NewConfigFromFile(file string) (config *Configuration, err error)

NewConfigFromFile creates a new configuration from a JSON file.

func (*Configuration) IsEnvLocal

func (c *Configuration) IsEnvLocal() bool

IsEnvLocal Returns whether we are in this environment.

func (*Configuration) IsEnvProduction

func (c *Configuration) IsEnvProduction() bool

IsEnvProduction Returns whether we are in this environment.

func (*Configuration) IsEnvTesting

func (c *Configuration) IsEnvTesting() bool

IsEnvTesting Returns whether we are in this environment.