config

Documentation

Index

• Variables
• type Config
• type DatabaseString
  • func ProvideDatabaseStringFromEnvironment() (DatabaseString, error)
• type DebugMode
  • func ProvideDebugModeFromEnvironment() (DebugMode, error)
• type InitTime
  • func ProvideInitTimeFromCurrentTime() InitTime
• type WebPort
  • func ProvideWebPortFromEnvironment() (WebPort, error)

Variables

var EnvironmentProviderSet = wire.NewSet(
	ProvideDatabaseStringFromEnvironment,
	ProvideWebPortFromEnvironment,
	ProvideDebugModeFromEnvironment,
	ProvideInitTimeFromCurrentTime,
)

EnvironmentProviderSet is a Wire provider set for environment configuration

Types

type Config

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

Config contains all the runtime configuration options

type DatabaseString

type DatabaseString string

DatabaseString is a string alias containing a database connection string

func ProvideDatabaseStringFromEnvironment

func ProvideDatabaseStringFromEnvironment() (DatabaseString, error)

ProvideDatabaseStringFromEnvironment creates a DatabaseString from the environment, or errors when it's missing

type DebugMode

type DebugMode bool

DebugMode is whether a debug state is set

func ProvideDebugModeFromEnvironment

func ProvideDebugModeFromEnvironment() (DebugMode, error)

ProvideDebugModeFromEnvironment creates a DebugMode based on the value in the DEBUG env var

type InitTime

type InitTime time.Time

InitTime is the program initialization time

func ProvideInitTimeFromCurrentTime

func ProvideInitTimeFromCurrentTime() InitTime

ProvideInitTimeFromCurrentTime initialized the program InitTime from the current time

type WebPort

type WebPort int

WebPort is the port that the web service will run on

func ProvideWebPortFromEnvironment

func ProvideWebPortFromEnvironment() (WebPort, error)

ProvideWebPortFromEnvironment creates a WebPort from the environment, defaulting to 8080 when missing