fxconfig

Documentation

Index

• Constants
• Variables
• type AppEnv
  • func FetchAppEnv(env string) AppEnv
  • func FetchAppEnvFromEnv() AppEnv
  • func (e AppEnv) String() string
• type Config
  • func NewFxConfig(p FxConfigParam) (*Config, error)
  • func (c *Config) AppDebug() bool
  • func (c *Config) AppEnv() AppEnv
  • func (c *Config) AppName() string
  • func (c *Config) AppVersion() string
• type ConfigFactory
  • func NewDefaultConfigFactory() ConfigFactory
• type ConfigOption
  • func WithFileName(n string) ConfigOption
  • func WithFilePaths(p ...string) ConfigOption
• type DefaultConfigFactory
  • func (f *DefaultConfigFactory) Create(options ...ConfigOption) (*Config, error)
• type FxConfigParam

Constants

const (
	AppEnvProd = "prod"
	AppEnvDev  = "dev"
	AppEnvTest = "test"

	DefaultAppEnv     = AppEnvProd
	DefaultAppName    = "app"
	DefaultAppVersion = "unknown"
)

Variables

var FxConfigModule = fx.Module("config",
	fx.Provide(
		NewDefaultConfigFactory,
		NewFxConfig,
	),
)

Types

type AppEnv

type AppEnv int

const (
	Prod AppEnv = iota
	Dev
	Test
)

func FetchAppEnv

func FetchAppEnv(env string) AppEnv

func FetchAppEnvFromEnv

func FetchAppEnvFromEnv() AppEnv

func (AppEnv) String

func (e AppEnv) String() string

type Config

type Config struct {
	*viper.Viper
}

func NewFxConfig

func NewFxConfig(p FxConfigParam) (*Config, error)

func (*Config) AppDebug

func (c *Config) AppDebug() bool

func (*Config) AppEnv

func (c *Config) AppEnv() AppEnv

func (*Config) AppName

func (c *Config) AppName() string

func (*Config) AppVersion

func (c *Config) AppVersion() string

type ConfigFactory

type ConfigFactory interface {
	Create(options ...ConfigOption) (*Config, error)
}

func NewDefaultConfigFactory

func NewDefaultConfigFactory() ConfigFactory

type ConfigOption

type ConfigOption func(o *options)

func WithFileName

func WithFileName(n string) ConfigOption

func WithFilePaths

func WithFilePaths(p ...string) ConfigOption

type DefaultConfigFactory

type DefaultConfigFactory struct{}

func (*DefaultConfigFactory) Create

func (f *DefaultConfigFactory) Create(options ...ConfigOption) (*Config, error)

type FxConfigParam

type FxConfigParam struct {
	fx.In
	Factory ConfigFactory
}