cfg

package

v0.2.13 Latest Latest Go to latest Published: Feb 8, 2024 License: MIT Imports: 15 Imported by: 3

Details

This section is empty.

This section is empty.

func Load(cfg any, opts ...Option) error

Load environment variables from `os env`, `.env` file and pass it to struct.

For local development use `.env` file from root project.

Load also call a `Validate` method.

Example:

var config internalConfig.Config
if err := cfg.Load(&config); err != nil {
	log.Fatalf("could not load configuration: %v", err)
}

func LoadForTests(cfg any, opts ...Option) error

LoadForTests environment variables from `os env`, `.env` file and pass it to struct for tests.

Disabled flags detection and any cli features.

For local development use `.env` file from root project.

LoadForTests also call a `Validate` method.

Example:

var config internalConfig.Config
if err := cfg.Load(&config); err != nil {
	log.Fatalf("could not load configuration: %v", err)
}

type Option func(*options)

func WithContext(v context.Context) Option

func WithEnvFile(v string) Option

func WithEnvPath(v string) Option

func WithValidate(v bool) Option

func WithValidateFuncs(items ...ValidateFn) Option

func WithVersion(v string) Option

type ValidateFn struct {
	Tag                      string
	Fn                       validator.Func
	CallValidationEvenIfNull []bool
}