config

package module

Go to main page

Versions in this module

v0

v0.2.6

Oct 31, 2024

v0.2.5

Aug 14, 2024

Changes in this version

type Option

+ Files []string

v0.2.4

Aug 10, 2024

v0.2.3

Aug 10, 2024

v0.2.2

Aug 10, 2024

v0.2.1

Aug 10, 2024

Changes in this version

+ func ENV() string

+ func Load(config interface{}, files ...string) error

+ func LoadWithKey(key string, config interface{}, files ...string) error

type Config

+ func (c *Config) GetEnvironment() string

+ func (c *Config) Load(config interface{}, files ...string) error

+ func (c *Config) LoadWithKey(key string, config interface{}, files ...string) (err error)

+ type Option struct

+ AutoReload bool

+ AutoReloadCallback func(config interface{})

+ AutoReloadInterval time.Duration

+ Debug bool

+ ENVPrefix string

+ Environment string

+ FS fs.FS

+ Silent bool

+ Verbose bool

+ type RawNode struct

+ func (n *RawNode) UnmarshalYAML(node *yaml.Node) error

v0.2.0

Aug 10, 2024

Changes in this version

+ const JSON

+ const OnCleanData

+ const OnLoadData

+ const OnReloadData

+ const OnSetData

+ const OnSetValue

+ const Yaml

+ var ErrKeyIsEmpty = errors.New("the config key is cannot be empty")

+ var ErrNotFound = errors.New("this key does not exist in the config")

+ var ErrReadonly = errors.New("the config instance in 'readonly' mode")

+ var YamlDriver = NewDriver("yaml", &yamlSerializer{}).WithAliases("yml")

+ func AddAlias(format, alias string)

+ func AddDriver(driver Driver)

+ func BindStruct(key string, dst any) error

+ func Bool(key string, defVal ...bool) bool

+ func ClearAll()

+ func Data() map[string]any

+ func Decode(dst any) error

+ func Delimiter(sep byte) func(*Options)

+ func DumpTo(out io.Writer, format string) (int64, error)

+ func Duration(key string, defVal ...time.Duration) time.Duration

+ func EnableCache(opts *Options)

+ func Exists(key string, findByPath ...bool) bool

+ func Float(key string, defVal ...float64) float64

+ func Get(key string, findByPath ...bool) any

+ func GetEnv(name string, defVal ...string) (val string)

+ func GetValue(key string, findByPath ...bool) (any, bool)

+ func Getenv(name string, defVal ...string) (val string)

+ func Int(key string, defVal ...int) int

+ func Int64(key string, defVal ...int64) int64

+ func IntMap(key string) map[string]int

+ func Ints(key string) []int

+ func Keys() []string

+ func LoadData(dataSource ...any) error

+ func LoadExists(sourceFiles ...string) error

+ func LoadExistsByFormat(format string, configFiles ...string) error

+ func LoadFiles(sourceFiles ...string) error

+ func LoadFilesByFormat(format string, configFiles ...string) error

+ func LoadFlags(keys []string) error

+ func LoadFromDir(dirPath, format string, loFns ...LoadOptFn) error

+ func LoadOSEnvs(nameToKeyMap map[string]string)

+ func LoadRemote(format, url string) error

+ func LoadSources(format string, src []byte, more ...[]byte) error

+ func LoadStrings(format string, str string, more ...string) error

+ func MapOnExists(key string, dst any) error

+ func MapStruct(key string, dst any) error

+ func MustString(key string) string

+ func ParseDefault(opts *Options)

+ func ParseEnv(opts *Options)

+ func ParseTime(opts *Options)

+ func Readonly(opts *Options)

+ func ReloadFiles() error

+ func Reset()

+ func SaveFileOnSet(fileName string, format string) func(options *Options)

+ func Set(key string, val any, setByPath ...bool) error

+ func SetData(data map[string]any)

+ func String(key string, defVal ...string) string

+ func StringMap(key string) map[string]string

+ func Strings(key string) []string

+ func StringsBySplit(key, sep string) []string

+ func Sub(key string) map[string]any

+ func SubDataMap(key string) maputil.Map

+ func Uint(key string, defVal ...uint) uint

+ func ValDecodeHookFunc(parseEnv, parseTime bool) mapstructure.DecodeHookFunc

+ func WithDriver(drivers ...Driver)

+ func WithHookFunc(fn HookFunc) func(*Options)

+ func WithOptions(opts ...OptionFn)

+ func WithTagName(tagName string) func(*Options)

+ func WriteTo(out io.Writer) (int64, error)

+ type Config struct

+ func Default() *Config

+ func New(name string, opts ...OptionFn) *Config

+ func NewEmpty(name string, opts ...OptionFn) *Config

+ func NewWith(name string, fn func(c *Config)) *Config

+ func NewWithOptions(name string, opts ...OptionFn) *Config

+ func (c *Config) AddAlias(format, alias string)

+ func (c *Config) AddDriver(driver Driver)

+ func (c *Config) AliasMap() map[string]string

+ func (c *Config) BindStruct(key string, dst any) error

+ func (c *Config) Bool(key string, defVal ...bool) (value bool)

+ func (c *Config) ClearAll()

+ func (c *Config) ClearCaches()

+ func (c *Config) ClearData()

+ func (c *Config) Data() map[string]any

+ func (c *Config) Decode(dst any) error

+ func (c *Config) DelDriver(format string)

+ func (c *Config) DriverNames() []string

+ func (c *Config) DumpTo(out io.Writer, format string) (n int64, err error)

+ func (c *Config) DumpToFile(fileName string, format string) (err error)

+ func (c *Config) Duration(key string, defVal ...time.Duration) time.Duration

+ func (c *Config) Error() error

+ func (c *Config) Exists(key string, findByPath ...bool) (ok bool)

+ func (c *Config) Float(key string, defVal ...float64) (value float64)

+ func (c *Config) Get(key string, findByPath ...bool) any

+ func (c *Config) GetValue(key string, findByPath ...bool) (value any, ok bool)

+ func (c *Config) HasDecoder(format string) bool

+ func (c *Config) HasEncoder(format string) bool

+ func (c *Config) Int(key string, defVal ...int) (value int)

+ func (c *Config) Int64(key string, defVal ...int64) (value int64)

+ func (c *Config) IntMap(key string) (mp map[string]int)

+ func (c *Config) Ints(key string) (arr []int)

+ func (c *Config) IsEmpty() bool

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

+ func (c *Config) LoadData(dataSources ...any) (err error)

+ func (c *Config) LoadExists(sourceFiles ...string) (err error)

+ func (c *Config) LoadExistsByFormat(format string, configFiles ...string) (err error)

+ func (c *Config) LoadFiles(sourceFiles ...string) (err error)

+ func (c *Config) LoadFilesByFormat(format string, configFiles ...string) (err error)

+ func (c *Config) LoadFlags(keys []string) (err error)

+ func (c *Config) LoadFromDir(dirPath, format string, loFns ...LoadOptFn) (err error)

+ func (c *Config) LoadOSEnvs(nameToKeyMap map[string]string)

+ func (c *Config) LoadRemote(format, url string) (err error)

+ func (c *Config) LoadSMap(smp map[string]string)

+ func (c *Config) LoadSources(format string, src []byte, more ...[]byte) (err error)

+ func (c *Config) LoadStrings(format string, str string, more ...string) (err error)

+ func (c *Config) LoadedFiles() []string

+ func (c *Config) LoadedUrls() []string

+ func (c *Config) MapOnExists(key string, dst any) error

+ func (c *Config) MapStruct(key string, dst any) error

+ func (c *Config) MustString(key string) string

+ func (c *Config) Name() string

+ func (c *Config) Options() *Options

+ func (c *Config) Readonly()

+ func (c *Config) ReloadFiles() (err error)

+ func (c *Config) Set(key string, val any, setByPath ...bool) (err error)

+ func (c *Config) SetData(data map[string]any)

+ func (c *Config) String(key string, defVal ...string) string

+ func (c *Config) StringMap(key string) (mp map[string]string)

+ func (c *Config) Strings(key string) (arr []string)

+ func (c *Config) StringsBySplit(key, sep string) (ss []string)

+ func (c *Config) Structure(key string, dst any) (err error)

+ func (c *Config) Sub(key string) map[string]any

+ func (c *Config) SubDataMap(key string) maputil.Map

+ func (c *Config) ToJSON() string

+ func (c *Config) Uint(key string, defVal ...uint) (value uint)

+ func (c *Config) With(fn func(c *Config)) *Config

+ func (c *Config) WithDriver(drivers ...Driver) *Config

+ func (c *Config) WithOptions(opts ...OptionFn) *Config

+ func (c *Config) WriteTo(out io.Writer) (n int64, err error)

+ type Driver interface

+ Aliases func() []string

+ GetSerializer func() Serializer

+ Name func() string

+ type HookFunc func(event string, c *Config)

+ type LoadOptFn func(lo *LoadOptions)

+ type LoadOptions struct

+ DataKey string

+ type OptionFn func(*Options)

+ type Options struct

+ DecoderConfig *mapstructure.DecoderConfig

+ Delimiter byte

+ DumpFormat string

+ EnableCache bool

+ HookFunc HookFunc

+ MergeOptions []func(*mergo.Config)

+ ParseDefault bool

+ ParseEnv bool

+ ParseKey bool

+ ParseTime bool

+ ReadFormat string

+ Readonly bool

+ func GetOptions() *Options

+ func (o *Options) SetTagName(tagName string)

+ type Serializer interface

+ Decode func(blob []byte, v any) (err error)

+ Encode func(v any) (out []byte, err error)

+ type StdDriver struct

+ func NewDriver(name string, serializer Serializer) *StdDriver

+ func (d *StdDriver) Aliases() []string

+ func (d *StdDriver) Decode(blob []byte, v any) (err error)

+ func (d *StdDriver) Encode(v any) ([]byte, error)

+ func (d *StdDriver) GetSerializer() Serializer

+ func (d *StdDriver) Name() string

+ func (d *StdDriver) WithAlias(alias string) *StdDriver

+ func (d *StdDriver) WithAliases(aliases ...string) *StdDriver

v0.1.1

Mar 19, 2024

Changes in this version

+ const Root

+ type LookupFunc = func(string) (string, bool)

+ type NopProvider struct

+ func (NopProvider) Name() string

+ func (n NopProvider) Get(_ string) Value

+ type Provider interface

+ Get func(key string) Value

+ Name func() string

+ func NewProviderGroup(name string, providers ...Provider) (Provider, error)

+ func NewScopedProvider(prefix string, provider Provider) Provider

+ type Value struct

+ func (v Value) Get(path string) Value

+ func (v Value) Populate(target interface{}) error

+ func (v Value) Source() string

+ func (v Value) String() string

+ type YAML struct

+ func NewYAML(options ...YAMLOption) (*YAML, error)

+ func (y *YAML) Get(key string) Value

+ func (y *YAML) Name() string

+ type YAMLOption interface

+ func Expand(lookup LookupFunc) YAMLOption

+ func File(name string) YAMLOption

+ func Name(name string) YAMLOption

+ func Permissive() YAMLOption

+ func RawSource(r io.Reader) YAMLOption

+ func Source(r io.Reader) YAMLOption

+ func Static(val interface{}) YAMLOption

v0.1.0

Feb 7, 2023

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