confkit

package module

Go to main page

Versions in this module

v0

v0.1.3

Jul 10, 2026

v0.1.2

Jul 10, 2026

v0.1.1

Jul 10, 2026

Changes in this version

+ const CodeCustomValidation

+ const CodeUnconfigured

type BoolField

+ func (f *BoolField) Validate(code, message string, fn func(bool) bool) *BoolField

type ConfigContract

+ func (c *ConfigContract) Strict() *ConfigContract

type DurationField

+ func (f *DurationField) Validate(code, message string, fn func(time.Duration) bool) *DurationField

type EnumField

+ func (f *EnumField) Validate(code, message string, fn func(string) bool) *EnumField

type FloatField

+ func (f *FloatField) Validate(code, message string, fn func(float64) bool) *FloatField

type IntField

+ func (f *IntField) Validate(code, message string, fn func(int) bool) *IntField

type ListField

+ func (f *ListField) Validate(code, message string, fn func([]string) bool) *ListField

type StringField

+ func (f *StringField) Validate(code, message string, fn func(string) bool) *StringField

v0.1.0

Jul 10, 2026

Changes in this version

+ const CodeDuplicateKey

+ const CodeInvalidContract

+ const CodeInvalidEmail

+ const CodeInvalidEnum

+ const CodeInvalidHost

+ const CodeInvalidIP

+ const CodeInvalidRegex

+ const CodeInvalidType

+ const CodeInvalidURL

+ const CodeMax

+ const CodeMin

+ const CodeNonEmpty

+ const CodeRegex

+ const CodeRequired

+ const CodeUnknown

+ func LoadEnv[T any]() (T, error)

+ func Load[T any](contract *ConfigContract, opts ...Option) (T, error)

+ func WriteExample(contract *ConfigContract, writer io.Writer) error

+ func WriteMarkdown(contract *ConfigContract, writer io.Writer) error

+ type BoolField struct

+ func Bool(key string) *BoolField

+ func (f *BoolField) Default(value bool) *BoolField

+ func (f *BoolField) Desc(description string) *BoolField

+ func (f *BoolField) Description(description string) *BoolField

+ func (f *BoolField) Optional() *BoolField

+ func (f *BoolField) Required() *BoolField

+ func (f *BoolField) Secret() *BoolField

+ type ConfigContract struct

+ func Contract(fields ...Field) *ConfigContract

+ type DurationField struct

+ func Duration(key string) *DurationField

+ func (f *DurationField) Default(value time.Duration) *DurationField

+ func (f *DurationField) Desc(description string) *DurationField

+ func (f *DurationField) Description(description string) *DurationField

+ func (f *DurationField) Max(max time.Duration) *DurationField

+ func (f *DurationField) Min(min time.Duration) *DurationField

+ func (f *DurationField) Optional() *DurationField

+ func (f *DurationField) Required() *DurationField

+ func (f *DurationField) Secret() *DurationField

+ type EnumField struct

+ func Enum(key string, values ...string) *EnumField

+ func (f *EnumField) Default(value string) *EnumField

+ func (f *EnumField) Desc(description string) *EnumField

+ func (f *EnumField) Description(description string) *EnumField

+ func (f *EnumField) Optional() *EnumField

+ func (f *EnumField) Required() *EnumField

+ func (f *EnumField) Secret() *EnumField

+ type Error struct

+ Issues []Issue

+ func (e *Error) Error() string

+ type Field interface

+ type FloatField struct

+ func Float(key string) *FloatField

+ func (f *FloatField) Default(value float64) *FloatField

+ func (f *FloatField) Desc(description string) *FloatField

+ func (f *FloatField) Description(description string) *FloatField

+ func (f *FloatField) Max(max float64) *FloatField

+ func (f *FloatField) Min(min float64) *FloatField

+ func (f *FloatField) Optional() *FloatField

+ func (f *FloatField) Required() *FloatField

+ func (f *FloatField) Secret() *FloatField

+ type IntField struct

+ func Int(key string) *IntField

+ func (f *IntField) Default(value int) *IntField

+ func (f *IntField) Desc(description string) *IntField

+ func (f *IntField) Description(description string) *IntField

+ func (f *IntField) Max(max int) *IntField

+ func (f *IntField) Min(min int) *IntField

+ func (f *IntField) Optional() *IntField

+ func (f *IntField) Required() *IntField

+ func (f *IntField) Secret() *IntField

+ type Issue struct

+ Code string

+ Key string

+ Message string

+ Secret bool

+ type ListField struct

+ func List(key string) *ListField

+ func (f *ListField) Default(value []string) *ListField

+ func (f *ListField) Desc(description string) *ListField

+ func (f *ListField) Description(description string) *ListField

+ func (f *ListField) Max(max int) *ListField

+ func (f *ListField) Min(min int) *ListField

+ func (f *ListField) Optional() *ListField

+ func (f *ListField) Required() *ListField

+ func (f *ListField) Secret() *ListField

+ func (f *ListField) Separator(separator string) *ListField

+ type Option func(*options)

+ func WithDotEnv(path string) Option

+ func WithRequiredDotEnv(path string) Option

+ func WithSource(source Source) Option

+ type Source interface

+ Lookup func(key string) (string, bool)

+ func MapSource(values map[string]string) Source

+ type StringField struct

+ func String(key string) *StringField

+ func (f *StringField) Default(value string) *StringField

+ func (f *StringField) Desc(description string) *StringField

+ func (f *StringField) Description(description string) *StringField

+ func (f *StringField) Email() *StringField

+ func (f *StringField) Hostname() *StringField

+ func (f *StringField) IP() *StringField

+ func (f *StringField) Max(max int) *StringField

+ func (f *StringField) Min(min int) *StringField

+ func (f *StringField) NonEmpty() *StringField

+ func (f *StringField) Optional() *StringField

+ func (f *StringField) Regex(pattern string) *StringField

+ func (f *StringField) Required() *StringField

+ func (f *StringField) Secret() *StringField

+ func (f *StringField) URL() *StringField

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