envconfig

Jul 19, 2026

Changes in this version

+ const ErrRecursivePointer

Jul 18, 2026

Changes in this version

+ const ErrRecursiveStruct

May 1, 2025

Changes in this version

+ type DecoderCtx interface

+ EnvDecode func(ctx context.Context, val string) error

+ type LookuperFunc func(key string) (string, bool)

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

Jul 6, 2024

Changes in this version

+ func MustProcess[T any](ctx context.Context, i T, mus ...Mutator) T

Dec 27, 2023

Changes in this version

+ type Config struct

+ DefaultDecodeUnset bool

+ DefaultDelimiter string

+ DefaultNoInit bool

+ DefaultOverwrite bool

+ DefaultRequired bool

+ DefaultSeparator string

+ Lookuper Lookuper

+ Mutators []Mutator

+ Target any

+ type Mutator interface

+ EnvMutate func(ctx context.Context, ...) (newValue string, stop bool, err error)

type MutatorFunc

+ func LegacyMutatorFunc(fn func(ctx context.Context, key, value string) (string, error)) MutatorFunc

+ func (m MutatorFunc) EnvMutate(ctx context.Context, ...) (newValue string, stop bool, err error)

Dec 1, 2022

Changes in this version

+ func ExtractDefaults(ctx context.Context, i interface{}, fns ...MutatorFunc) error

Feb 3, 2022

Changes in this version

+ const ErrNoInitNotPtr

Apr 22, 2021

Changes in this version

+ const ErrInvalidEnvvarName

Aug 7, 2020

Changes in this version

+ type Base64Bytes []byte

+ func (b *Base64Bytes) EnvDecode(val string) error

+ func (b Base64Bytes) Bytes() []byte

+ type HexBytes []byte

+ func (b *HexBytes) EnvDecode(val string) error

+ func (b HexBytes) Bytes() []byte

Aug 4, 2020

Changes in this version

+ const ErrPrefixNotStruct

+ type Error string

+ func (e Error) Error() string

Jun 30, 2020

Changes in this version

+ var ErrInvalidMapItem = fmt.Errorf("invalid map item")

+ var ErrLookuperNil = fmt.Errorf("lookuper cannot be nil")

+ var ErrMissingKey = fmt.Errorf("missing key")

+ var ErrMissingRequired = fmt.Errorf("missing required value")

+ var ErrNotPtr = fmt.Errorf("input must be a pointer")

+ var ErrNotStruct = fmt.Errorf("input must be a struct")

+ var ErrPrivateField = fmt.Errorf("cannot parse private fields")

+ var ErrRequiredAndDefault = fmt.Errorf("field cannot be required and have a default value")

+ var ErrUnknownOption = fmt.Errorf("unknown option")

+ func Process(ctx context.Context, i interface{}) error

+ func ProcessWith(ctx context.Context, i interface{}, l Lookuper, fns ...MutatorFunc) error

+ type Decoder interface

+ EnvDecode func(val string) error

+ type Lookuper interface

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

+ func MapLookuper(m map[string]string) Lookuper

+ func MultiLookuper(lookupers ...Lookuper) Lookuper

+ func OsLookuper() Lookuper

+ func PrefixLookuper(prefix string, l Lookuper) Lookuper

+ type MutatorFunc func(ctx context.Context, k, v string) (string, error)