functions

Documentation

Index

• func All(t *template.Template) template.FuncMap
• func And(expr ...interface{}) interface{}
• func Bracket(s interface{}) string
• func BracketWith(b string, s interface{}) (string, error)
• func CombineFunctionLists(fnList ...template.FuncMap) template.FuncMap
• func Contains(list interface{}, item interface{}) (bool, error)
• func EncodingFunctions() template.FuncMap
• func Filter(list interface{}, item interface{}) (interface{}, error)
• func First(list interface{}) (interface{}, error)
• func FormatJSON(indent string, j string) (string, error)
• func FromBase64(s string) (string, error)
• func GenerateIncludeFn(t *template.Template) func(string, interface{}) (string, error)
• func Indent(t int, content string) string
• func IsZero(val interface{}) bool
• func Join(list interface{}) (string, error)
• func JoinWith(glue string, list interface{}) (string, error)
• func Last(list interface{}) (interface{}, error)
• func List(s ...interface{}) (interface{}, error)
• func ListFunctions() template.FuncMap
• func LogicFunctions() template.FuncMap
• func MiscellaneousFunctions() template.FuncMap
• func Newline(c ...int) string
• func Now() string
• func Or(expr ...interface{}) interface{}
• func PadLeft(n int, s interface{}) string
• func PadRight(n int, s interface{}) string
• func Pop(list interface{}) (interface{}, error)
• func Prefix(prefix string, t int, content string) string
• func Push(list interface{}, item interface{}) (interface{}, error)
• func QuoteBack(s interface{}) string
• func QuoteDouble(s interface{}) string
• func QuoteSingle(s interface{}) string
• func Rep(n int, s ...string) string
• func Rest(list interface{}) (interface{}, error)
• func Slice(i, j int, list interface{}) (interface{}, error)
• func Space(n int) string
• func SplitOn(glue string, s string) []string
• func StringFunctions() template.FuncMap
• func Suffix(suffix string, t int, content string) string
• func Tab(n int) string
• func TemplateFunctions(t *template.Template) template.FuncMap
• func TerminalWidth() int
• func TitleCaseWithAbbr(abbrev interface{}, word string) (string, error)
• func ToBase64(s string) string
• func ToColumn(w int, s string) string
• func ToJSON(val interface{}) (string, error)
• func ToYAML(val interface{}) (string, error)
• func TypeKind(val interface{}) string
• func TypeName(val interface{}) string
• func Unindent(t int, content string) (string, error)
• func Unshift(list interface{}, item interface{}) (interface{}, error)
• func UppercaseFirst(s interface{}) string
• func When(d, s interface{}) interface{}
• func WhenEmpty(d, s interface{}) interface{}

Examples

• Contains
• Filter
• First
• Last
• List
• Pop
• Push
• Rest
• Slice
• ToColumn
• Unshift

Functions

func All

func All(t *template.Template) template.FuncMap

All returns all the templating functions

func And

func And(expr ...interface{}) interface{}

And returns the value of the last expression if all expressions evaluate to non-zero, or empty string otherwise

func Bracket

func Bracket(s interface{}) string

Bracket adds brackets around the given string

func BracketWith

func BracketWith(b string, s interface{}) (string, error)

BracketWith adds brackets of a given type around the given string

func CombineFunctionLists

func CombineFunctionLists(fnList ...template.FuncMap) template.FuncMap

CombineFunctionLists together from zero more supplied lists

func Contains

func Contains(list interface{}, item interface{}) (bool, error)

Contains returns true if the item is present in the list

Example

helperApplyAndRenderTemplate(contains, a)

Output:

{{.a}}              = [a b c d e]
{{contains .a "x"}} = false
{{contains .a "d"}} = true
{{contains .a 3}}   = false

func EncodingFunctions

func EncodingFunctions() template.FuncMap

EncodingFunctions for encoding and decoding various formats

func Filter

func Filter(list interface{}, item interface{}) (interface{}, error)

Filter returns list with all instances of item removed

Example

helperApplyAndRenderTemplate(filter, a)

Output:

{{.a}}            = [a b c d e]
{{filter .a "x"}} = [a b c d e]
{{filter .a 3}}   = [a b c d e]
{{filter .a "c"}} = [a b d e]

{{.b}}            = [f o o b a r]
{{filter .b "o"}} = [f b a r]

func First

func First(list interface{}) (interface{}, error)

First returns the head of a list

Example

helperApplyAndRenderTemplate(first, a)

Output:

{{.a}}       = [a b c d e]
{{first .a}} = a

func FormatJSON

func FormatJSON(indent string, j string) (string, error)

FormatJSON returns the given json string, formatted with the given indent string

func FromBase64

func FromBase64(s string) (string, error)

FromBase64 decodes the given encoded string to plain

func GenerateIncludeFn

func GenerateIncludeFn(t *template.Template) func(string, interface{}) (string, error)

GenerateIncludeFn creates a function to be used as an "include" function in templates

func Indent

func Indent(t int, content string) string

Indent prints the given string with the given number of spaces prepended before each line

func IsZero

func IsZero(val interface{}) bool

IsZero returns true if the value given corresponds to its types zero value, points to something zero valued, or if it's a type with a length which is 0

func Join

func Join(list interface{}) (string, error)

Join joins the given strings together

func JoinWith

func JoinWith(glue string, list interface{}) (string, error)

JoinWith joins the given strings together using the given string as glue

func Last

func Last(list interface{}) (interface{}, error)

Last returns the last item of a list

Example

helperApplyAndRenderTemplate(last, a)

Output:

{{.a}}      = [a b c d e]
{{last .a}} = e

func List

func List(s ...interface{}) (interface{}, error)

List returns a new list comprised of the given elements

Example

helperApplyAndRenderTemplate(list, a)

Output:

{{list "a" "b" "c"}} = [a b c]
{{list "a" 5 false}} = [a 5 false]
{{range list 1 2 3}}{{bracket .}}{{end}} = (1)(2)(3)

func ListFunctions

func ListFunctions() template.FuncMap

ListFunctions operate on collections of items

func LogicFunctions

func LogicFunctions() template.FuncMap

LogicFunctions perform logical operations

func MiscellaneousFunctions

func MiscellaneousFunctions() template.FuncMap

MiscellaneousFunctions are functions that don't have a more specific home

func Newline

func Newline(c ...int) string

Newline prints a newline (handy for trying to format templates)

func Now

func Now() string

Now returns the current time in the format "2006-01-02T15:04:05Z07:00"

func Or

func Or(expr ...interface{}) interface{}

Or returns the first expression that evaluates to non-zero, or empty string if none do

func PadLeft

func PadLeft(n int, s interface{}) string

PadLeft prints the given string in the given number of columns, left aligned

func PadRight

func PadRight(n int, s interface{}) string

PadRight prints the given string in the given number of columns, right aligned

func Pop

func Pop(list interface{}) (interface{}, error)

Pop removes the first element of the list, returning the list

Example

helperApplyAndRenderTemplate(pop, a)

Output:

{{.a}}     = [a b c d e]
{{pop .a}} = [a b c d]

func Prefix

func Prefix(prefix string, t int, content string) string

Prefix prints the given string with the given number of 'prefix' prepended before each line

func Push

func Push(list interface{}, item interface{}) (interface{}, error)

Push returns the list with item appended

Example

helperApplyAndRenderTemplate(push, a)

Output:

{{.a}}          = [a b c d e]
{{push .a "x"}} = [a b c d e x]

func QuoteBack

func QuoteBack(s interface{}) string

QuoteBack adds back-quotes around the given string

func QuoteDouble

func QuoteDouble(s interface{}) string

QuoteDouble adds double quote around the given string

func QuoteSingle

func QuoteSingle(s interface{}) string

QuoteSingle adds single quote around the given string

func Rep

func Rep(n int, s ...string) string

Rep repeats the given string(s) the given number of times

func Rest

func Rest(list interface{}) (interface{}, error)

Rest / Shift returns the tail of a list

Example

helperApplyAndRenderTemplate(rest, a)

Output:

{{.a}}      = [a b c d e]
{{rest .a}} = [b c d e]

func Slice

func Slice(i, j int, list interface{}) (interface{}, error)

Slice returns a slice of a list where i is the lower index (inclusive) and j is the upper index (exclusive) to extract

Example

helperApplyAndRenderTemplate(slice, a)

Output:

{{.a}}           = [a b c d e]
{{slice 1 3 .a}} = [b c]

func Space

func Space(n int) string

Space prints a space character the given number of times

func SplitOn

func SplitOn(glue string, s string) []string

SplitOn creates an array from the given string by separating it by the glue string

func StringFunctions

func StringFunctions() template.FuncMap

StringFunctions primary operate on strings

func Suffix

func Suffix(suffix string, t int, content string) string

Suffix prints the given string with the given number of 'suffix' appended to each line

func Tab

func Tab(n int) string

Tab prints a tab character the given number of times

func TemplateFunctions

func TemplateFunctions(t *template.Template) template.FuncMap

TemplateFunctions operate on templates themselves

func TerminalWidth

func TerminalWidth() int

TerminalWidth returns the number of columns that the terminal currently has, or 0 if the program isn't run in one, or it can't otherwise be determined

func TitleCaseWithAbbr

func TitleCaseWithAbbr(abbrev interface{}, word string) (string, error)

TitleCaseWithAbbr upper-cases the first letter of each word, or the whole word if it matches a given abbreviation

func ToBase64

func ToBase64(s string) string

ToBase64 converts the given string to a base64 encoding

func ToColumn

func ToColumn(w int, s string) string

ToColumn formats the given text to not take more than 'w' characters per line, splitting on the space before the word that would take the line over. If no space can be found, the line isn't split (ie words bigger than the line size are printed unsplit)

Example

ExampleToColumn

w := 40
s := "Lorem ipsum dolor\nsit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."

got := ToColumn(w, s)

fmt.Println(got)

Output:

Lorem ipsum dolor
sit amet, consectetur adipiscing elit,
sed do eiusmod tempor incididunt ut
labore et dolore magna aliqua. Ut enim
ad minim veniam, quis nostrud
exercitation ullamco laboris nisi ut
aliquip ex ea commodo consequat.

func ToJSON

func ToJSON(val interface{}) (string, error)

ToJSON returns the given value as a json string

func ToYAML

func ToYAML(val interface{}) (string, error)

ToYAML returns the given value as a yaml string

func TypeKind

func TypeKind(val interface{}) string

TypeKind returns the 'kind” of the given value as a string

func TypeName

func TypeName(val interface{}) string

TypeName returns the type of the given value as a string

func Unindent

func Unindent(t int, content string) (string, error)

Unindent removes up to 't' spaces from the start of all lines within content

func Unshift

func Unshift(list interface{}, item interface{}) (interface{}, error)

Unshift returns the list with item prepended

Example

helperApplyAndRenderTemplate(unshift, a)

Output:

{{.a}}             = [a b c d e]
{{unshift .a "x"}} = [x a b c d e]

func UppercaseFirst

func UppercaseFirst(s interface{}) string

UppercaseFirst converts the first character in a string to uppercase

func When

func When(d, s interface{}) interface{}

When returns the second argument if the first is not "empty", otherwise it returns an empty string

func WhenEmpty

func WhenEmpty(d, s interface{}) interface{}

WhenEmpty returns the second argument if the first is "empty", otherwise it returns the first