enverant

Documentation

Index

• Variables
• func EnrichStr(value string) string
• func ReadJson(path string) map[string]interface{}
• type EnvParamsData
• type Enverant
  • func NewEnverant(opts ...EnverantOption) *Enverant
  • func (e *Enverant) GetBool(key string, opts ...ValueOption) bool
  • func (e *Enverant) GetBoolOr(key string, default_ bool, opts ...ValueOption) bool
  • func (e *Enverant) GetBoolean(key string, opts ...ValueOption) (bool, bool)
  • func (e *Enverant) GetInt(key string, opts ...ValueOption) int
  • func (e *Enverant) GetIntOr(key string, default_ int, opts ...ValueOption) int
  • func (e *Enverant) GetInteger(key string, opts ...ValueOption) (int, bool)
  • func (e *Enverant) GetParams() []*EnvParamsData
  • func (e *Enverant) GetPtrBool(key string, opts ...ValueOption) *bool
  • func (e *Enverant) GetPtrInt(key string, opts ...ValueOption) *int
  • func (e *Enverant) GetPtrStr(key string, opts ...ValueOption) *string
  • func (e *Enverant) GetStr(key string, opts ...ValueOption) string
  • func (e *Enverant) GetStrOr(key string, default_ string, opts ...ValueOption) string
  • func (e *Enverant) GetString(key string, opts ...ValueOption) (string, bool)
  • func (m *Enverant) GetValidating() *Enverant
  • func (e *Enverant) LookupEnv(key string, params *ValueParams) (string, bool)
  • func (e *Enverant) ValidetNoUnused()
• type EnverantOption
  • func WithDescription(Description string) EnverantOption
  • func WithPrefix(prefix string) EnverantOption
  • func WithValidate(validate bool) EnverantOption
• type ValueOption
  • func OrBool(default_ bool) ValueOption
  • func OrInt(default_ int) ValueOption
  • func OrStr(default_ string) ValueOption
  • func WithDesc(description string) ValueOption
• type ValueParams
• type VarType
  • func (v VarType) ToStr() string

Variables

var EnverantDebug = os.Getenv("ENVERANT_PRINT_JSON") == "true"

Functions

func EnrichStr

func EnrichStr(value string) string

func ReadJson

func ReadJson(path string) map[string]interface{}

Types

type EnvParamsData

type EnvParamsData struct {
	*ValueParams
	PrefixedKey string
	Value       string
}

type Enverant

type Enverant struct {
	Description string
	// contains filtered or unexported fields
}

func NewEnverant

func NewEnverant(opts ...EnverantOption) *Enverant

func (*Enverant) GetBool

func (e *Enverant) GetBool(key string, opts ...ValueOption) bool

func (*Enverant) GetBoolOr

func (e *Enverant) GetBoolOr(key string, default_ bool, opts ...ValueOption) bool

func (*Enverant) GetBoolean

func (e *Enverant) GetBoolean(key string, opts ...ValueOption) (bool, bool)

func (*Enverant) GetInt

func (e *Enverant) GetInt(key string, opts ...ValueOption) int

func (*Enverant) GetIntOr

func (e *Enverant) GetIntOr(key string, default_ int, opts ...ValueOption) int

func (*Enverant) GetInteger

func (e *Enverant) GetInteger(key string, opts ...ValueOption) (int, bool)

func (*Enverant) GetParams

func (e *Enverant) GetParams() []*EnvParamsData

func (*Enverant) GetPtrBool

func (e *Enverant) GetPtrBool(key string, opts ...ValueOption) *bool

func (*Enverant) GetPtrInt

func (e *Enverant) GetPtrInt(key string, opts ...ValueOption) *int

func (*Enverant) GetPtrStr

func (e *Enverant) GetPtrStr(key string, opts ...ValueOption) *string

func (*Enverant) GetStr

func (e *Enverant) GetStr(key string, opts ...ValueOption) string

func (*Enverant) GetStrOr

func (e *Enverant) GetStrOr(key string, default_ string, opts ...ValueOption) string

func (*Enverant) GetString

func (e *Enverant) GetString(key string, opts ...ValueOption) (string, bool)

func (*Enverant) GetValidating

func (m *Enverant) GetValidating() *Enverant

func (*Enverant) LookupEnv

func (e *Enverant) LookupEnv(key string, params *ValueParams) (string, bool)

func (*Enverant) ValidetNoUnused

func (e *Enverant) ValidetNoUnused()

type EnverantOption

type EnverantOption func(m *Enverant)

func WithDescription

func WithDescription(Description string) EnverantOption

func WithPrefix

func WithPrefix(prefix string) EnverantOption

func WithValidate

func WithValidate(validate bool) EnverantOption

type ValueOption

type ValueOption func(m *ValueParams)

func OrBool

func OrBool(default_ bool) ValueOption

func OrInt

func OrInt(default_ int) ValueOption

func OrStr

func OrStr(default_ string) ValueOption

func WithDesc

func WithDesc(description string) ValueOption

WithDesc - is used to build help information

type ValueParams

type ValueParams struct {
	VarType     VarType
	Default     any
	Description string
}

type VarType

type VarType int64

const (
	VarBool VarType = iota
	VarInt
	VarStr
)

func (VarType) ToStr

func (v VarType) ToStr() string