configuration

package

v0.4.0 Latest Latest Go to latest Published: Dec 27, 2022 License: GPL-3.0 Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/go-catupiry/catu

Links

Open Source Insights

Documentation ¶

Index ¶

func GetBoolEnv(key string, fallback bool) bool
func GetEnv(key, fallback string) string
func GetInt64Env(key string, fallback int64) int64
func GetIntEnv(key string, fallback int) int
type Cfg
type ConfigurationInterface
- func NewCfg() ConfigurationInterface

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GetBoolEnv ¶

func GetBoolEnv(key string, fallback bool) bool

Get environment variable value as boolean

func GetEnv ¶

func GetEnv(key, fallback string) string

Get environment variable value as string

func GetInt64Env ¶

func GetInt64Env(key string, fallback int64) int64

Get environment variable value as int64

func GetIntEnv ¶

func GetIntEnv(key string, fallback int) int

Get environment variable value as int

Types ¶

type Cfg ¶

type Cfg struct {
}

Configuration object with usefull methods

func (Cfg) Get ¶

func (c Cfg) Get(key string) string

Get - Get environment variable value or "" if not exists

func (Cfg) GetBool ¶

func (c Cfg) GetBool(key string) bool

GetBoolEnv - Get an boolean env var. This returns false to invalid values

func (Cfg) GetBoolF ¶ added in v0.0.1

func (c Cfg) GetBoolF(key string, fallback bool) bool

GetBoolEnv - Get an boolean environment var with default value. This returns false to invalid values

func (Cfg) GetF ¶ added in v0.0.1

func (c Cfg) GetF(key, fallback string) string

func (Cfg) GetInt ¶

func (c Cfg) GetInt(key string) int

func (Cfg) GetInt64 ¶

func (c Cfg) GetInt64(key string) int64

func (Cfg) GetInt64F ¶ added in v0.0.1

func (c Cfg) GetInt64F(key string, fallback int64) int64

func (Cfg) GetIntF ¶ added in v0.0.1

func (c Cfg) GetIntF(key string, fallback int) int

func (Cfg) Init ¶

func (c Cfg) Init() error

type ConfigurationInterface ¶ added in v0.0.11

type ConfigurationInterface interface {
	Init() error
	Get(key string) string
	GetBool(key string) bool
	GetInt(key string) int
	GetInt64(key string) int64

	GetF(key, fallback string) string
	GetBoolF(key string, fallback bool) bool
	GetIntF(key string, fallback int) int
	GetInt64F(key string, fallback int64) int64
}

Default interface to be used on others modules

func NewCfg ¶

func NewCfg() ConfigurationInterface

Build and get a new Cfg object

Source Files ¶

View all Source files

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