config

package

v0.0.0-...-35a4376 Latest Latest Go to latest Published: Jan 6, 2024 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Ferrany1/system-tools

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

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
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL