fig

README

fig

reading and loading configuration from yaml / json files

Documentation

Index

• Variables
• func Bool(keys ...string) bool
• func BoolOr(defaultVal bool, keys ...string) bool
• func Exists(keys ...string) bool
• func Float(keys ...string) float64
• func FloatOr(defaultVal float64, keys ...string) float64
• func Int(keys ...string) int
• func IntOr(defaultVal int, keys ...string) int
• func Interface(keys ...string) interface{}
• func Map(keys ...string) map[string]interface{}
• func MustExist(key string)
• func Reset()
• func String(keys ...string) string
• func StringOr(defaultVal string, keys ...string) string
• func StringSlice(keys ...string) []string
• func StringSliceOr(defaultVal []string, keys ...string) []string
• func Struct(addr interface{}, keys ...string)

Variables

var EnvironmentOrder = []string{"prod", "dev", "config"}

var ExtensionOrder = []string{".yaml", ".json"}

var FolderOrder = []string{"./config/", ""}

var ShowFiles = true

ShowFiles if set to true, will output the files to StdOut which were read to build the overall configuration

Functions

func Bool

func Bool(keys ...string) bool

Bool returns the bool value at the given key. Panics if the key is missing.

func BoolOr

func BoolOr(defaultVal bool, keys ...string) bool

BoolOr returns the bool value at the given key. If key is missing it returns defaultVal

func Exists

func Exists(keys ...string) bool

Exists checks if the given key is present. It also loads configuration (if missing)

func Float

func Float(keys ...string) float64

Float returns the float value at the given key. Panics if the key is missing.

func FloatOr

func FloatOr(defaultVal float64, keys ...string) float64

FloatOr returns the float64 value at the given key. If key is missing it returns defaultVal

func Int

func Int(keys ...string) int

Int returns the int value at the given key. Panics if the key is missing.

func IntOr

func IntOr(defaultVal int, keys ...string) int

IntOr returns the int value at the given key. If key is missing it returns defaultVal

func Interface

func Interface(keys ...string) interface{}

Interface returns the generic value corresponding to a key.

func Map

func Map(keys ...string) map[string]interface{}

Map returns a map a the given key. Panics if the key is missing.

func MustExist

func MustExist(key string)

MustExist panics if the given configuration key is missing

func Reset

func Reset()

Reset loads the configuration

func String

func String(keys ...string) string

String returns the string value at the given key. Panics if the key is missing.

func StringOr

func StringOr(defaultVal string, keys ...string) string

StringOr returns the string value at the given key. If key is missing it returns defaultVal

func StringSlice

func StringSlice(keys ...string) []string

StringSlice returns a splice of string at the given key. Panics if the key is not present.

func StringSliceOr

func StringSliceOr(defaultVal []string, keys ...string) []string

StringSliceOr returns a splice of string at the given key. If key is missing it returns defaultVal.

func Struct

func Struct(addr interface{}, keys ...string)

Struct is used to parse and load simple structures. Most common use is reading connection strings. Note that it does not work for nested structs or arrays