synthra

package module

Go to main page

Versions in this module

v0

v0.12.0

May 20, 2026

Changes in this version

+ type Configurable struct

+ func (c *Configurable) Delete(path string) bool

+ func (c *Configurable) EachMap(path string) iter.Seq2[int, *Configurable]

+ func (c *Configurable) Find(path, field, match string) *Configurable

+ func (c *Configurable) FindFunc(path string, pred func(*Configurable) bool) *Configurable

+ func (c *Configurable) Raw() map[string]any

+ func (c *Configurable) Set(path string, value any) error

+ func (c *Configurable) Walk(fn func(path string, value any) (any, bool))

+ type Configuration struct

+ func (c *Configuration) Bool(path string) (bool, error)

+ func (c *Configuration) BoolOr(path string, def bool) bool

+ func (c *Configuration) Duration(path string) (time.Duration, error)

+ func (c *Configuration) DurationOr(path string, def time.Duration) time.Duration

+ func (c *Configuration) EachMap(path string) iter.Seq2[int, *Configuration]

+ func (c *Configuration) Find(path, field, match string) *Configuration

+ func (c *Configuration) FindFunc(path string, pred func(*Configuration) bool) *Configuration

+ func (c *Configuration) Float64(path string) (float64, error)

+ func (c *Configuration) Float64Or(path string, def float64) float64

+ func (c *Configuration) Get(path string) any

+ func (c *Configuration) Has(path string) bool

+ func (c *Configuration) Int(path string) (int, error)

+ func (c *Configuration) Int64(path string) (int64, error)

+ func (c *Configuration) Int64Or(path string, def int64) int64

+ func (c *Configuration) IntOr(path string, def int) int

+ func (c *Configuration) IntSlice(path string) ([]int, error)

+ func (c *Configuration) IntSliceOr(path string, def []int) []int

+ func (c *Configuration) Keys() []string

+ func (c *Configuration) Raw() map[string]any

+ func (c *Configuration) SliceLen(path string) int

+ func (c *Configuration) String(path string) (string, error)

+ func (c *Configuration) StringMap(path string) (map[string]any, error)

+ func (c *Configuration) StringMapOr(path string, def map[string]any) map[string]any

+ func (c *Configuration) StringMapString(path string) (map[string]string, error)

+ func (c *Configuration) StringOr(path, def string) string

+ func (c *Configuration) StringSlice(path string) ([]string, error)

+ func (c *Configuration) StringSliceOr(path string, def []string) []string

+ func (c *Configuration) Time(path string) (time.Time, error)

+ func (c *Configuration) TimeOr(path string, def time.Time) time.Time

type Resolver

+ func CoalesceEnvFile(paths ...string) (Resolver, error)

+ func FromEnvFileIfExists(path string) (Resolver, error)

type Synthra

+ func (c *Synthra) Configuration() *Configuration

v0.11.0

May 20, 2026

v0.10.0

May 20, 2026

Changes in this version

+ type Reader interface

+ Bool func(path string) (bool, error)

+ BoolOr func(path string, def bool) bool

+ Duration func(path string) (time.Duration, error)

+ DurationOr func(path string, def time.Duration) time.Duration

+ Float64 func(path string) (float64, error)

+ Float64Or func(path string, def float64) float64

+ Get func(path string) any

+ Has func(path string) bool

+ Int func(path string) (int, error)

+ Int64 func(path string) (int64, error)

+ Int64Or func(path string, def int64) int64

+ IntOr func(path string, def int) int

+ IntSlice func(path string) ([]int, error)

+ IntSliceOr func(path string, def []int) []int

+ Keys func() []string

+ String func(path string) (string, error)

+ StringMap func(path string) (map[string]any, error)

+ StringMapOr func(path string, def map[string]any) map[string]any

+ StringMapString func(path string) (map[string]string, error)

+ StringOr func(path, def string) string

+ StringSlice func(path string) ([]string, error)

+ StringSliceOr func(path string, def []string) []string

+ Time func(path string) (time.Time, error)

+ TimeOr func(path string, def time.Time) time.Time

+ type Snapshot struct

+ func (s *Snapshot) Bool(path string) (bool, error)

+ func (s *Snapshot) BoolOr(path string, def bool) bool

+ func (s *Snapshot) Duration(path string) (time.Duration, error)

+ func (s *Snapshot) DurationOr(path string, def time.Duration) time.Duration

+ func (s *Snapshot) Float64(path string) (float64, error)

+ func (s *Snapshot) Float64Or(path string, def float64) float64

+ func (s *Snapshot) Get(path string) any

+ func (s *Snapshot) Has(path string) bool

+ func (s *Snapshot) Int(path string) (int, error)

+ func (s *Snapshot) Int64(path string) (int64, error)

+ func (s *Snapshot) Int64Or(path string, def int64) int64

+ func (s *Snapshot) IntOr(path string, def int) int

+ func (s *Snapshot) IntSlice(path string) ([]int, error)

+ func (s *Snapshot) IntSliceOr(path string, def []int) []int

+ func (s *Snapshot) Keys() []string

+ func (s *Snapshot) Raw() map[string]any

+ func (s *Snapshot) String(path string) (string, error)

+ func (s *Snapshot) StringMap(path string) (map[string]any, error)

+ func (s *Snapshot) StringMapOr(path string, def map[string]any) map[string]any

+ func (s *Snapshot) StringMapString(path string) (map[string]string, error)

+ func (s *Snapshot) StringOr(path, def string) string

+ func (s *Snapshot) StringSlice(path string) ([]string, error)

+ func (s *Snapshot) StringSliceOr(path string, def []string) []string

+ func (s *Snapshot) Time(path string) (time.Time, error)

+ func (s *Snapshot) TimeOr(path string, def time.Time) time.Time

type Synthra

+ func (c *Synthra) Snapshot() *Snapshot

type Values

+ func (v *Values) IntSliceOr(path string, def []int) []int

+ func (v *Values) StringMapOr(path string, def map[string]any) map[string]any

+ func (v *Values) StringMapString(path string) (map[string]string, error)

+ func (v *Values) StringSliceOr(path string, def []string) []string

+ func (v *Values) TimeOr(path string, def time.Time) time.Time

v0.9.0

May 19, 2026

Changes in this version

+ type BindingOption interface

+ func OnBound[T any](fn func(*T) error) BindingOption[T]

type Resolver

+ func (r Resolver) Or(fallbacks ...Resolver) Resolver

+ type Values struct

+ func (v *Values) Bool(path string) (bool, error)

+ func (v *Values) BoolOr(path string, def bool) bool

+ func (v *Values) Delete(path string) bool

+ func (v *Values) Duration(path string) (time.Duration, error)

+ func (v *Values) DurationOr(path string, def time.Duration) time.Duration

+ func (v *Values) Float64(path string) (float64, error)

+ func (v *Values) Float64Or(path string, def float64) float64

+ func (v *Values) Get(path string) any

+ func (v *Values) Has(path string) bool

+ func (v *Values) Int(path string) (int, error)

+ func (v *Values) Int64(path string) (int64, error)

+ func (v *Values) Int64Or(path string, def int64) int64

+ func (v *Values) IntOr(path string, def int) int

+ func (v *Values) IntSlice(path string) ([]int, error)

+ func (v *Values) Keys() []string

+ func (v *Values) Raw() map[string]any

+ func (v *Values) Set(path string, value any) error

+ func (v *Values) String(path string) (string, error)

+ func (v *Values) StringMap(path string) (map[string]string, error)

+ func (v *Values) StringOr(path, def string) string

+ func (v *Values) StringSlice(path string) ([]string, error)

+ func (v *Values) Time(path string) (time.Time, error)

+ func (v *Values) Walk(fn func(path string, value any) (any, bool))

v0.8.0

May 19, 2026

Changes in this version

type Option

+ func WithEnvSubstFunc(fn func(map[string]any) (Resolver, error)) Option

+ func WithJSONSchemaFunc(selector func(map[string]any) ([]byte, error)) Option

+ type Resolver func(name string) (value string, found bool)

+ func FromEnv() Resolver

+ func FromEnvFile(path string) (Resolver, error)

+ func FromMap(m map[string]string) Resolver

+ func (r Resolver) Prefix(prefix string) Resolver

v0.7.0

May 17, 2026

v0.6.0

May 17, 2026

Changes in this version

type Option

+ func WithEnvSubst(resolvers ...resolve.Resolver) Option

v0.5.0

May 17, 2026

v0.4.0

May 17, 2026

v0.3.0

May 17, 2026

v0.2.0

May 17, 2026

Changes in this version

type Option

+ func WithInterpolation(vars map[string]string) Option

+ func WithJSONSchemaSelector(fn func(map[string]any) ([]byte, error)) Option

+ func WithTransform(fn func(map[string]any) (map[string]any, error)) Option

v0.1.0

May 17, 2026

Changes in this version

+ const OpDump

+ const OpGet

+ const OpLoad

+ const OpNew

+ var ErrKeyNotFound = errors.New("synthra: key not found")

+ var ErrNilConfig = errors.New("synthra: nil Synthra")

+ var ErrNilContext = errors.New("synthra: nil context")

+ func GetOr[T any](c *Synthra, key string, defaultVal T) T

+ func Get[T any](c *Synthra, key string) (T, error)

+ type ConfigError struct

+ Err error

+ Op string

+ Path string

+ func NewConfigError(op, path string, err error) *ConfigError

+ func (e *ConfigError) Error() string

+ func (e *ConfigError) Unwrap() error

+ type Dumper interface

+ Dump func(ctx context.Context, values *map[string]any) error

+ type Option func(cfg *config)

+ func WithBinding(v any) Option

+ func WithConsul(path string) Option

+ func WithConsulAs(path string, decoder codec.Decoder) Option

+ func WithContent(data []byte, decoder codec.Decoder) Option

+ func WithDumper(d Dumper) Option

+ func WithEnv(prefix string) Option

+ func WithFile(path string) Option

+ func WithFileAs(path string, decoder codec.Decoder) Option

+ func WithFileDumper(path string) Option

+ func WithFileDumperAs(path string, encoder codec.Encoder) Option

+ func WithFileFS(fsys fs.FS, path string) Option

+ func WithFileFSAs(fsys fs.FS, path string, decoder codec.Decoder) Option

+ func WithIf(condition bool, opts ...Option) Option

+ func WithJSONSchema(schema []byte) Option

+ func WithSource(loader Source) Option

+ func WithTag(tagName string) Option

+ func WithValidator(fn func(map[string]any) error) Option

+ type Source interface

+ Load func(ctx context.Context) (map[string]any, error)

+ type Synthra struct

+ func MustNew(opts ...Option) *Synthra

+ func New(opts ...Option) (*Synthra, error)

+ func (c *Synthra) Bool(key string) (bool, error)

+ func (c *Synthra) BoolOr(key string, defaultVal bool) bool

+ func (c *Synthra) Dump(ctx context.Context) error

+ func (c *Synthra) Duration(key string) (time.Duration, error)

+ func (c *Synthra) DurationOr(key string, defaultVal time.Duration) time.Duration

+ func (c *Synthra) Float64(key string) (float64, error)

+ func (c *Synthra) Float64Or(key string, defaultVal float64) float64

+ func (c *Synthra) Get(key string) any

+ func (c *Synthra) Int(key string) (int, error)

+ func (c *Synthra) Int64(key string) (int64, error)

+ func (c *Synthra) Int64Or(key string, defaultVal int64) int64

+ func (c *Synthra) IntOr(key string, defaultVal int) int

+ func (c *Synthra) IntSlice(key string) ([]int, error)

+ func (c *Synthra) IntSliceOr(key string, defaultVal []int) []int

+ func (c *Synthra) Load(ctx context.Context) error

+ func (c *Synthra) String(key string) (string, error)

+ func (c *Synthra) StringMap(key string) (map[string]any, error)

+ func (c *Synthra) StringMapOr(key string, defaultVal map[string]any) map[string]any

+ func (c *Synthra) StringOr(key, defaultVal string) string

+ func (c *Synthra) StringSlice(key string) ([]string, error)

+ func (c *Synthra) StringSliceOr(key string, defaultVal []string) []string

+ func (c *Synthra) Time(key string) (time.Time, error)

+ func (c *Synthra) TimeOr(key string, defaultVal time.Time) time.Time

+ func (c *Synthra) Values() *map[string]any

+ type Validator interface

+ Validate func() error

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