xii

README

xii

My take on 12 Factor

Usage

AsBool

development, err := xii.AsBool("DEVELOPMENT", xii.BoolOpts{DefaultValue: false})
if err != nil {
	log.Fatal(err)
}
log.Printf("[xii] %-30s == %v\n", "DEVELOPMENT", development)

AsInt

port, err := xii.AsInt("PORT", xii.IntOpts{DefaultValue: 8080})
if err != nil {
	log.Fatal(err)
}
log.Printf("[xii] %-30s == %d\n", "PORT", port)

AsString

appRoot, err := xii.AsString("APPROOT", xii.StringOpts{DefaultValue: "./"})
if err != nil {
	log.Fatal(err)
}
log.Printf("[xii] %-30s == %q\n", "APPROOT", appRoot)

Documentation

Overview

Package xii contains helpers for 12 Factor.

Index

• Constants
• func AsBool(key string, opts BoolOpts) (bool, error)
• func AsInt(key string, opts IntOpts) (int, error)
• func AsString(key string, opts StringOpts) (string, error)
• func GetBool(opts BoolOpts, keys ...string) (keyFound string, val bool, err error)
• func GetInt(opts IntOpts, keys ...string) (keyFound string, val int, err error)
• func GetString(opts StringOpts, keys ...string) (keyFound string, val string, err error)
• func SearchEnv(keys ...string) (key, val string, err error)
• type BoolOpts
• type IntOpts
• type StringOpts

Constants

const (
	ExtraSpaces    = constError("must not contain leading or trailing spaces")
	InvalidBoolean = constError("must be either true or false")
	InvalidInteger = constError("must be a valid integer")
	IsBlank        = constError("must not be blank")
	NotExported    = constError("must be exported")
)

Errors used by the package.

Functions

func AsBool

func AsBool(key string, opts BoolOpts) (bool, error)

AsBool retrieves a boolean value from the environment. Returns an error if the value is missing or invalid.

func AsInt

func AsInt(key string, opts IntOpts) (int, error)

AsInt is retrieves an integer value from the environment. Returns an error if the value is missing or invalid.

func AsString

func AsString(key string, opts StringOpts) (string, error)

AsString retrieves a string from the environment. Returns an error if the string is not set.

func GetBool

func GetBool(opts BoolOpts, keys ...string) (keyFound string, val bool, err error)

GetBool searches the environment for a list of keys. Returns the matching key's name and value. Returns an error if the key is not set or the value is invalid.

func GetInt

func GetInt(opts IntOpts, keys ...string) (keyFound string, val int, err error)

GetInt searches the environment for a list of keys. Returns the matching key's name and value. Returns an error if the key is not set or the value is invalid.

func GetString

func GetString(opts StringOpts, keys ...string) (keyFound string, val string, err error)

GetString searches the environment for a list of keys. Returns the matching key's name and value. Returns an error if the key is not set or the value is invalid.

func SearchEnv

func SearchEnv(keys ...string) (key, val string, err error)

SearchEnv searches the environment for a list of keys. Returns the matching key's name and value. Returns an error if the key is not set or the value is invalid.

Types

type BoolOpts

type BoolOpts struct {
	Required     bool
	DefaultKey   string
	DefaultValue bool
	Help         string // short help message if required and not found
}

BoolOpts specifies if a value is required or has a default value.

type IntOpts

type IntOpts struct {
	Required     bool
	DefaultKey   string
	DefaultValue int
	Help         string // short help message if required and not found
}

IntOpts is

type StringOpts

type StringOpts struct {
	Required     bool
	DefaultKey   string
	DefaultValue string
	Help         string // short help message if required and not found
}

StringOpts is