config

Documentation

Index

• func BindPFlag(key string, flag *pflag.Flag)
• func Bool(environmentVariable string) *boolBuilder
• func Get() *applicationConfigType
• func GetSanatizedDefaultValue(valueDescriptor *Descriptor) string
• func GetTruncated(valueDescriptor *Descriptor, value any) string
• func Int(environmentVariable string) *intBuilder
• func LoadConfig(values []Value) error
• func LoadConfigWithOptions(values []Value, options *LoadConfigOptions) error
• func MaskSensitiveString(valueDescriptor *Descriptor, value string) string
• func Print()
• func Set() *valueSetter
• func String(environmentVariable string) *stringBuilder
• func StringArray(environmentVariable string) *stringArrayBuilder
• type Descriptor
• type LoadConfigOptions
• type TypeInfo
• type Value
• type ValueType

Functions

func BindPFlag

func BindPFlag(key string, flag *pflag.Flag)

func Bool

func Bool(environmentVariable string) *boolBuilder

func Get

func Get() *applicationConfigType

func GetSanatizedDefaultValue

func GetSanatizedDefaultValue(valueDescriptor *Descriptor) string

func GetTruncated

func GetTruncated(valueDescriptor *Descriptor, value any) string

func Int

func Int(environmentVariable string) *intBuilder

func LoadConfig

func LoadConfig(values []Value) error

func LoadConfigWithOptions

func LoadConfigWithOptions(values []Value, options *LoadConfigOptions) error

func MaskSensitiveString

func MaskSensitiveString(valueDescriptor *Descriptor, value string) string

func Print

func Print()

func Set

func Set() *valueSetter

func String

func String(environmentVariable string) *stringBuilder

func StringArray

func StringArray(environmentVariable string) *stringArrayBuilder

Types

type Descriptor

type Descriptor struct {
	EnvionmentVariable string
	Default            any
	Provided           bool
	Value              any
	NotEmpty           bool
	Sensitive          bool
	TypeInfo           TypeInfo
}

type LoadConfigOptions

type LoadConfigOptions struct {
	DotEnvFile  string
	DotEnvFiles []string
}

type TypeInfo

type TypeInfo struct {
	Type ValueType
}

type Value

type Value interface {
	Descriptor() *Descriptor
}

type ValueType

type ValueType string

const (
	StringType      ValueType = "string"
	StringArrayType ValueType = "string_array"
	BoolType        ValueType = "bool"
	IntType         ValueType = "int"
)