config

Documentation

Index

• func FieldValidation(config any, fieldValidator map[string]func(any) error) error
• func GenerateDotEnvFromConfig(serviceName, filePath string, config WithValidation) error
• func GenericNumberLowerOrEmptyValidator[T NumberTypeGeneric]() func(any) error
• func GenericStringNotEmptyValidator[T ~string]() func(any) error
• func GetConfigField[T WithValidation](config WithValidation, fieldValueMatchers ...func(T) bool) (T, error)
• func LoadConfig(configStruct WithValidation, nodePath string, loadOptions ...Option) error
• func ValidationValidator() func(any) error
• type NumberTypeGeneric
• type Option
  • func WithEnvLoadOption(envVarPrefixOption ...string) Option
  • func WithJSONLoadOption(filePath string) Option
• type WithValidation

Functions

func FieldValidation

func FieldValidation(config any, fieldValidator map[string]func(any) error) error

func GenerateDotEnvFromConfig

func GenerateDotEnvFromConfig(serviceName, filePath string, config WithValidation) error

func GenericNumberLowerOrEmptyValidator

func GenericNumberLowerOrEmptyValidator[T NumberTypeGeneric]() func(any) error

func GenericStringNotEmptyValidator

func GenericStringNotEmptyValidator[T ~string]() func(any) error

func GetConfigField

func GetConfigField[T WithValidation](
	config WithValidation,
	fieldValueMatchers ...func(T) bool,
) (T, error)

func LoadConfig

func LoadConfig(configStruct WithValidation, nodePath string, loadOptions ...Option) error

func ValidationValidator

func ValidationValidator() func(any) error

Types

type NumberTypeGeneric

type NumberTypeGeneric interface {
	~uint8 | ~uint16 | ~uint32 | ~uint64 | ~uint |
		~int8 | ~int16 | ~int32 | ~int64 | ~int |
		~float32 | ~float64
}

type Option

type Option struct {
	Provider      koanf.Provider
	Parser        koanf.Parser
	UnmarshalConf koanf.UnmarshalConf
}

func WithEnvLoadOption

func WithEnvLoadOption(envVarPrefixOption ...string) Option

func WithJSONLoadOption

func WithJSONLoadOption(filePath string) Option

type WithValidation

type WithValidation interface {
	ValidateConfigFields() error
}