config

Documentation

Overview

Package config provides a global config store that other packages can utilise for fetching/storing configuration. The config store supports both file and environment configuration.

Index

• Constants
• Variables
• func GetBaseURL() string
• func GetVersion() string
• func IsProduction() bool
• func Load[T any](envPrefix string, cfg T) error
• type Environment
  • func GetEnvironment() Environment
  • func (e Environment) String() string
• type Timeout
  • func (t Timeout) Duration() time.Duration
  • func (t Timeout) Validate() error

Constants

const (
	// AppName is the application name.
	AppName = "Foragd"
	// AppID is the application name formatted for use as an ID.
	AppID = "app.foragd"
	// AppDescription is the catch-line of the application.
	AppDescription = "" /* 136-byte string literal not displayed */
	// ConfigEnvPrefix defines the environment variable prefix for reading
	// server configuration from the environment.
	ConfigEnvPrefix = "FORAGD_"
)

Variables

var (
	ErrLoadConfig    = errors.New("error loading config")
	ErrInvalidConfig = errors.New("invalid config")
)

Functions

func GetBaseURL

func GetBaseURL() string

func GetVersion

func GetVersion() string

func IsProduction

func IsProduction() bool

func Load

func Load[T any](envPrefix string, cfg T) error

Load will load a config via environment variables with the given prefix into an object of the given type.

Types

type Environment

type Environment string

Environment is the app running environment.

const (
	// EnvDevelopment represents a development environment.
	EnvDevelopment Environment = "development"
	// EnvProduction represents a production envrionment.
	EnvProduction Environment = "production"
)

func GetEnvironment

func GetEnvironment() Environment

func (Environment) String

func (e Environment) String() string

type Timeout

type Timeout string

func (Timeout) Duration

func (t Timeout) Duration() time.Duration

func (Timeout) Validate

func (t Timeout) Validate() error