env

Documentation

Index

• Variables
• func NewSource(opts ...source.Option) source.Source
• func WithPrefix(p ...string) source.Option
• func WithStrippedPrefix(p ...string) source.Option

Variables

var (
	DefaultPrefixes = []string{}
)

Functions

func NewSource

func NewSource(opts ...source.Option) source.Source

NewSource returns a config source for parsing ENV variables. Underscores are delimiters for nesting, and all keys are lowercased.

Example:

"DATABASE_SERVER_HOST=localhost" will convert to

{
    "database": {
        "server": {
            "host": "localhost"
        }
    }
}

func WithPrefix

func WithPrefix(p ...string) source.Option

WithPrefix sets the environment variable prefixes to scope to. These prefixes will not be removed. Each prefix will be considered a top level config entry.

func WithStrippedPrefix

func WithStrippedPrefix(p ...string) source.Option

WithStrippedPrefix sets the environment variable prefixes to scope to. These prefixes will be removed from the actual config entries.