bviper

README

bviper

Viper brick to be used by Bricks

Documentation

Index

• Constants
• func Builder() cfg.Builder
• func CustomBuilder(custom *viper.Viper) cfg.Builder

Constants

const (
	// EnvKeyDelimiterFrom shell environment delimiter
	EnvKeyDelimiterFrom = "_"
	// EnvKeyDelimiterTo delimiter used by application
	EnvKeyDelimiterTo = "."
)

Functions

func Builder

func Builder() cfg.Builder

Builder creates a simple viper instance with a given config file path configFilePath should point to a file that have one of these extensions:

"json", "toml", "yaml", "yml", "properties", "props", "prop", "hcl", "dotenv", "env", "ini"

func CustomBuilder

func CustomBuilder(custom *viper.Viper) cfg.Builder

CustomBuilder allows one to use an already initialized and configure Viper instance

Note:

It's important to receive a viper instance that is already initialized using viper.ReadInConfig() or viper.ReadConfig(in io.Reader) or viper.ReadRemoteConfig()

Also note that all other Builder function will do nothing since we assume this instance is configured properly