README
¶
envconf
Boostrap for operations with config file or env variables. Read/Save config files like "~/.app" with sections and Set/Get env variables.
Get Started
Config file sample:
[main]
name = test
[server]
[client]
Usages:
import "github.com/devfans/envconf"
func main() {
config := envconf.NewConfig("~/.app")
// get name key from config from default section: [main]
name := config.Get("name")
// get sections
server := config.GetSection("server")
client := config.GetSection("client")
// add new keys
server.Put("ip", "localhost")
client.Put("ip", "0.0.0.0")
// save to disk as file "~/.app"
config.Save()
// other usages
config.Section = "server" // switch current section
serverIp := config.String("ip") // localhost
config.Get("SERVER_IP", "ip") // get env first if env variable is not null
config.Getenv("SERVER_IP")
config.Setenv("SERVER_IP", "localhost")
}
dotenv
# file: .env
[main]
use_section = case1
[case1]
name = a
[case2]
name = b
Example
import (
"os"
"testing"
"github.com/devfans/envconf/dotenv"
)
func TestEnv(t *testing.T) {
t.Log(os.Getenv("a"))
t.Log(os.Getenv("b"))
t.Log(dotenv.Int("a"))
t.Log(dotenv.Uint("b"))
t.Log(dotenv.Bool("c"))
t.Log(dotenv.Bool("d"))
t.Log(os.Getenv("test"))
t.Log(dotenv.String("test"))
t.Log(dotenv.EnvConf().Get("a"))
t.Log(dotenv.EnvConf().Get("b"))
}
Documentation
¶
Index ¶
- func ParseValue(value string) string
- type Config
- func (c *Config) Bool(args ...interface{}) bool
- func (c *Config) Fetch(args ...interface{}) Value
- func (c *Config) Float(args ...interface{}) float64
- func (c *Config) Get(args ...interface{}) Value
- func (c *Config) GetConf(args ...interface{}) Value
- func (c *Config) GetEnv(args ...interface{}) Value
- func (c *Config) GetSection(section string) Section
- func (c *Config) Getenv(key interface{}) string
- func (c *Config) Getkey(key interface{}) string
- func (c *Config) Int(args ...interface{}) int64
- func (c *Config) List() []string
- func (c *Config) Put(args ...interface{})
- func (c *Config) Save()
- func (c *Config) Setenv(key, value interface{})
- func (c *Config) String(args ...interface{}) string
- func (c *Config) Uint(args ...interface{}) uint64
- type Section
- func (sec Section) Bool(args ...interface{}) bool
- func (sec Section) Fetch(args ...interface{}) Value
- func (sec Section) Float(args ...interface{}) float64
- func (sec Section) Get(args ...interface{}) Value
- func (sec Section) GetConf(args ...interface{}) Value
- func (sec Section) GetEnv(args ...interface{}) Value
- func (sec Section) Getenv(key interface{}) string
- func (sec Section) Getkey(key interface{}) string
- func (sec Section) Int(args ...interface{}) int64
- func (sec Section) List() []string
- func (sec Section) Put(args ...interface{})
- func (sec Section) Setenv(key, value interface{})
- func (sec Section) String(args ...interface{}) string
- func (sec Section) Uint(args ...interface{}) uint64
- type Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ParseValue ¶ added in v0.0.3
ParseValue will parse config from raw string
Types ¶
type Config ¶
Config struct has map to contains secions and an attribute to indicate the current section
func NewEmptyConfig ¶ added in v0.0.4
func NewEmptyConfig() *Config
NewEmptyConfig creates an empty Config instance
func (*Config) Bool ¶ added in v0.0.4
Bool parse env value as bool
args set: (name) args set: (name, defaultValue)
func (*Config) Fetch ¶
Feth will get key values from config
At least the key name should be provided ¶
Parameter sets: conf_key
Parameter sets: conf_key, env_key
Parameter sets: conf_key, env_key, default_value
When env_key is provided it will try to fetch env variable only if the value of conf_key is empty
func (*Config) Float ¶ added in v0.0.8
Float parse env value as float64
args set: (name) args set: (name, defaultValue)
func (*Config) Get ¶
Get will get key values from config
At least the key name should be provided ¶
Parameter sets: conf_key
Parameter sets: env_key, conf_key
Parameter sets: env_key, conf_key, default_value
When env_key is provided it will try to fetch env variable first, if it's empty, it will try to get it from config
func (*Config) GetConf ¶
GetConf will get key values from config
At least the key name should be provided ¶
Parameter sets: conf_key
Parameter sets: conf_key, default_value
func (*Config) GetEnv ¶
GetEnv will get key values from env
At least the key name should be provided ¶
Parameter sets: env_key
Parameter sets: env_key, default_value
func (*Config) GetSection ¶
GetSection gets config section with name
func (*Config) Int ¶ added in v0.0.4
Int parse env value as int64
args set: (name) args set: (name, defaultValue)
func (*Config) Setenv ¶
func (c *Config) Setenv(key, value interface{})
Setenv is a sugar for config object to set env
type Section ¶
type Section map[string]interface{}
Section is a based on map, not thread safe
func NewSection ¶
NewSection will create new section in config
func (Section) Bool ¶ added in v0.0.4
Bool parse config value as bool
args set: (name) args set: (name, defaultValue)
func (Section) Float ¶ added in v0.0.8
Float parse config value as float64
args set: (name) args set: (name, defaultValue)
func (Section) Get ¶
Get will get config key, args pattern: envKey, configKey, defaultValue or just configKey
func (Section) Int ¶ added in v0.0.4
Int parse config value as int64
args set: (name) args set: (name, defaultValue)
func (Section) Put ¶
func (sec Section) Put(args ...interface{})
Put will add new key with or without value
func (Section) Setenv ¶
func (sec Section) Setenv(key, value interface{})
Setenv is a sugar for section object to set env
Source Files
Directories