Documentation
¶
Overview ¶
Package envvar loads environment-backed configuration through explicit adapter helpers.
Safe startup paths ------------------
The adapter keeps legacy panic-oriented methods (Must*) and adds Try* variants that return parse errors instead of panicking:
token, err := adapter.TryGet("TOKEN")
if err != nil { ... }
// or
if err := adapter.TryLoadEnvFiles([]string{"./.env"}); err != nil { ... }
This allows callers to keep startup failure strictness where desired while preserving a non-panicking path for validation and diagnostics.
Bind helpers ------------
Use TryBind/TryBindWithPrefix when loading config structs if you want to handle parse errors explicitly:
var cfg Config
if err := adapter.TryBindWithPrefix(&cfg, "APP_"); err != nil { ... }
Index ¶
- func New() ports.EnvVar
- type Adapter
- func (a *Adapter) Bind(dst any) error
- func (a *Adapter) BindWithPrefix(dst any, prefix string) error
- func (a *Adapter) DumpRedacted() map[string]string
- func (a *Adapter) Get(key string) (string, bool)
- func (a *Adapter) GetBoolOr(key string, def bool) bool
- func (a *Adapter) GetDurationOr(key string, def time.Duration) time.Duration
- func (a *Adapter) GetFloat64Or(key string, def float64) float64
- func (a *Adapter) GetInt64Or(key string, def int64) int64
- func (a *Adapter) GetIntOr(key string, def int) int
- func (a *Adapter) GetOr(key, def string) string
- func (a *Adapter) GetUint64Or(key string, def uint64) uint64
- func (a *Adapter) GetUintOr(key string, def uint) uint
- func (a *Adapter) LoadEnvFiles(paths []string) error
- func (a *Adapter) MustBind(dst any)
- func (a *Adapter) MustBindWithPrefix(dst any, prefix string)
- func (a *Adapter) MustGet(key string) string
- func (a *Adapter) MustGetBool(key string) bool
- func (a *Adapter) MustGetDuration(key string) time.Duration
- func (a *Adapter) MustGetFloat64(key string) float64
- func (a *Adapter) MustGetInt(key string) int
- func (a *Adapter) MustGetInt64(key string) int64
- func (a *Adapter) MustGetUint(key string) uint
- func (a *Adapter) MustGetUint64(key string) uint64
- func (a *Adapter) MustLoadEnvFiles(paths []string)
- func (a *Adapter) TryBind(dst any) error
- func (a *Adapter) TryBindWithPrefix(dst any, prefix string) error
- func (a *Adapter) TryGet(key string) (string, error)
- func (a *Adapter) TryGetBool(key string) (bool, error)
- func (a *Adapter) TryGetDuration(key string) (time.Duration, error)
- func (a *Adapter) TryGetFloat64(key string) (float64, error)
- func (a *Adapter) TryGetInt(key string) (int, error)
- func (a *Adapter) TryGetInt64(key string) (int64, error)
- func (a *Adapter) TryGetUint(key string) (uint, error)
- func (a *Adapter) TryGetUint64(key string) (uint64, error)
- func (a *Adapter) TryLoadEnvFiles(paths []string) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Adapter ¶
type Adapter struct{}
Adapter provides environment variable access using the envvar library.
func (*Adapter) Bind ¶
Bind populates a struct from environment variables. This is a simplified implementation that doesn't use struct tags.
func (*Adapter) BindWithPrefix ¶
BindWithPrefix binds with a prefix.
func (*Adapter) DumpRedacted ¶
DumpRedacted returns environment with secrets redacted.
func (*Adapter) GetDurationOr ¶
GetDurationOr returns the value as duration or default if not present.
func (*Adapter) GetFloat64Or ¶
GetFloat64Or returns the value as float64 or default if not present.
func (*Adapter) GetInt64Or ¶
GetInt64Or returns the value as int64 or default if not present.
func (*Adapter) GetUint64Or ¶
GetUint64Or returns the value as uint64 or default if not present.
func (*Adapter) LoadEnvFiles ¶
LoadEnvFiles loads environment variables from files. Tries .env then /env/.env by default.
func (*Adapter) MustBindWithPrefix ¶
MustBindWithPrefix panics on binding errors with prefix.
func (*Adapter) MustGetBool ¶
MustGetBool returns the value as boolean or panics if not present.
func (*Adapter) MustGetDuration ¶
MustGetDuration returns the value as duration or panics if not present.
func (*Adapter) MustGetFloat64 ¶
MustGetFloat64 returns the value as float64 or panics if not present.
func (*Adapter) MustGetInt ¶
MustGetInt returns the value as integer or panics if not present.
func (*Adapter) MustGetInt64 ¶
MustGetInt64 returns the value as int64 or panics if not present.
func (*Adapter) MustGetUint ¶
MustGetUint returns the value as uint or panics if not present.
func (*Adapter) MustGetUint64 ¶
MustGetUint64 returns the value as uint64 or panics if not present.
func (*Adapter) MustLoadEnvFiles ¶
MustLoadEnvFiles panics on errors when loading environment files.
func (*Adapter) TryBindWithPrefix ¶ added in v2.1.0
TryBindWithPrefix binds with a prefix and returns errors.
func (*Adapter) TryGetBool ¶ added in v2.1.0
TryGetBool returns the value as boolean or an error.
func (*Adapter) TryGetDuration ¶ added in v2.1.0
TryGetDuration returns the value as duration or an error.
func (*Adapter) TryGetFloat64 ¶ added in v2.1.0
TryGetFloat64 returns the value as float64 or an error.
func (*Adapter) TryGetInt64 ¶ added in v2.1.0
TryGetInt64 returns the value as int64 or an error.
func (*Adapter) TryGetUint ¶ added in v2.1.0
TryGetUint returns the value as uint or an error.
func (*Adapter) TryGetUint64 ¶ added in v2.1.0
TryGetUint64 returns the value as uint64 or an error.
func (*Adapter) TryLoadEnvFiles ¶ added in v2.1.0
TryLoadEnvFiles loads environment variable files and returns an error.
Source Files