config

package

v1.2.0 Latest Latest Go to latest Published: Oct 25, 2023 License: Apache-2.0 Imports: 8 Imported by: 4

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/mxcd/go-config

Links

Open Source Insights

Documentation ¶

Index ¶

func BindPFlag(key string, flag *pflag.Flag)
func Bool(environmentVariable string) *boolBuilder
func Get() *applicationConfigType
func GetSanatizedDefaultValue(valueDescriptor *Descriptor) string
func GetSensitiveProtectedValue(valueDescriptor *Descriptor) string
func Int(environmentVariable string) *intBuilder
func LoadConfig(values []Value) error
func Print()
func Set() *valueSetter
func String(environmentVariable string) *stringBuilder
type Descriptor
type TypeInfo
type Value
type ValueType

Constants ¶

This section is empty.

Variables ¶

This section is empty.

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 GetSensitiveProtectedValue ¶

func GetSensitiveProtectedValue(valueDescriptor *Descriptor) string

func Int ¶

func Int(environmentVariable string) *intBuilder

func LoadConfig ¶

func LoadConfig(values []Value) error

func Print ¶

func Print()

func Set ¶

func Set() *valueSetter

func String ¶

func String(environmentVariable string) *stringBuilder

Types ¶

type Descriptor ¶

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

type TypeInfo ¶

type TypeInfo struct {
	Type ValueType
}

type Value ¶

type Value interface {
	Descriptor() *Descriptor
}

type ValueType ¶

type ValueType string

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

Source Files ¶

View all Source files

config.go

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