configs

Documentation

Index

• Variables
• func LoadDotenv() error
• func Read(i any, envPrefix string, file string) (err error)
• func ReadFromFile(i any, filename string) error
• type Config
  • func (c *Config) Overwrite(ov Overwrites) error
  • func (c *Config) Read() (err error)
  • func (c *Config) ReadFromEnv(i any, prefix string) error
  • func (c *Config) UnusedEnvKeys() []string
  • func (c *Config) UsedEnvKeys() []string
• type EnvTag
  • func ParseEnvTag(tag string) (EnvTag, error)
• type Overwrites
  • func ReadOverwritingFile(cfg any, filename string) (ov Overwrites, err error)

Variables

var EnvFile = ".env"

var FileExtensions = map[string]func(data []byte, v any) error{
	".json": json.Unmarshal,
	".yaml": yaml.Unmarshal,
}

Functions

func LoadDotenv

func LoadDotenv() error

func Read

func Read(i any, envPrefix string, file string) (err error)

func ReadFromFile

func ReadFromFile(i any, filename string) error

Types

type Config

type Config struct {
	Value          any
	Overwrites     Overwrites
	EnvPrefix      string
	File           string
	IgnoreEnv      bool
	IgnoreDotEnv   bool
	OverwritesFile string
	// contains filtered or unexported fields
}

func (*Config) Overwrite

func (c *Config) Overwrite(ov Overwrites) error

func (*Config) Read

func (c *Config) Read() (err error)

func (*Config) ReadFromEnv

func (c *Config) ReadFromEnv(i any, prefix string) error

func (*Config) UnusedEnvKeys

func (c *Config) UnusedEnvKeys() []string

func (*Config) UsedEnvKeys

func (c *Config) UsedEnvKeys() []string

type EnvTag

type EnvTag struct {
	Name string
}

func ParseEnvTag

func ParseEnvTag(tag string) (EnvTag, error)

type Overwrites

type Overwrites map[string]any

func ReadOverwritingFile

func ReadOverwritingFile(cfg any, filename string) (ov Overwrites, err error)