Functions#

Engine#

engine.RenderContent#

Description

The RenderContent function takes a template name and data, then renders the content using the TemplateEngine.

Signature

RenderContent(templateName String, data Object) String

Parameters

Return

{{ $context := GetContextByBase .BaseContext "Set::exampleSet" "Project::exampleProject" "Resource::exampleResource" }}
{{ $templateName := "exampleTemplate" }}
{{ $renderedContent := RenderContent $templateName $context }}
Result: {{ $renderedContent }}

Result: Rendered content of template: exampleTemplate with data: { ...context data... }

engine.GetContent#

Description

The GetContent method in the engine space retrieves the content of a shared template based on the specified template name. It uses the SharedTemplateService to fetch the template. If an error occurs or the template is not found, it returns an empty String.

Signature

GetContent(templateName String) string

Parameters

Return

{{ $templateName := "exampleTemplate" }}
{{ $templateContent := GetContent $templateName }}
Content: {{ $templateContent }}

Content: The content of the template: exampleTemplate

engine.RenderTemplate#

Description

The RenderTemplate method in the engine space renders a template using the specified template name and data. It retrieves the template content using the GetContent method and processes it with the TemplateEngine function. If an error occurs, it returns an empty string.

Signature

RenderTemplate(templateName string, data any) string

Parameters

Return

{{ $templateName := "exampleTemplate" }}
{{ $data := .ExampleData }}
{{ $renderedContent := RenderTemplate $templateName $data }}
Content: {{ $renderedContent }}

Content: The rendered content of the template: exampleTemplate with provided data.

Context#

context.GetContextByBase#

Description

The GetContextByBase function retrieves a TemplateDataContext based on the provided base context and additional arguments. It resolves and validates various components like set, resource, layer, project, section, and template.

Signature

GetContextByBase(base Context, args ...String) Context

Parameters

Return

{{ $context := GetContextByBase .BaseContext "Set::exampleSet" "Project::exampleProject" "Resource::exampleResource" }}
Result: {{ $context }}

Result: {Resolved context information based on provided arguments}

context.GetContextByBaseForArray#

Description

The GetContextByBaseForArray function retrieves a Context based on the provided base context and additional arguments in an array format. It internally calls GetContextByBase to perform the resolution.

Signature

GetContextByBaseForArray(base Context, args []String) Context

Parameters

Return

{{ $context := GetContextByBaseForArray .BaseContext (slice "Set::exampleSet" "Project::exampleProject" "Resource::exampleResource") }}
Result: {{ $context }}

Result: {Resolved context information based on provided arguments}

Logical Operators#

and#

Description

The and function returns true if all provided boolean arguments are true. If any of the arguments is false, the function returns false.

Signature

and(args ...Boolean) Boolean

Parameters

Return

{{ $result := and true true false }}
Result: {{ $result }}

Result: false

or#

Description

The or function returns true if at least one of the provided boolean arguments is true. If all arguments are false, the function returns false.

Signature

or(args ...Boolean) Boolean

Parameters

Return

{{ $result := or false true false }}
Result: {{ $result }}

Result: true

not#

Description

The not function returns the boolean negation of the provided argument. It returns true if the argument is false, and false if the argument is true.

Signature

not(arg Boolean) Boolean

Parameters

Return

{{ $result := not true }}
Result: {{ $result }}

Result: false

Comparison Operators#

eq#

Description

The eq function returns the boolean truth of whether arg1 is equal to arg2.

Signature

eq(arg1 Object, arg2 Object) Boolean

Parameters

Return

{{ $result := eq 5 5 }}
Result: {{ $result }}

Result: true

ne#

Description

The ne function returns the boolean truth of whether arg1 is not equal to arg2.

Signature

ne(arg1 Object, arg2 Object) Boolean

Parameters

Return

{{ $result := ne 5 3 }}
Result: {{ $result }}

Result: true

lt#

Description

The lt function returns the boolean truth of whether arg1 is less than arg2.

Signature

lt(arg1 Number, arg2 Number) Boolean

Parameters

Return

{{ $result := ne 3 5 }}
Result: {{ $result }}

Result: true

le#

Description

The le function returns the boolean truth of whether arg1 is less than or equal arg2.

Signature

le(arg1 Number, arg2 Number) Boolean

Parameters

Return

{{ $result := le 5 5 }}
Result: {{ $result }}

Result: true

gt#

Description

The gt function returns the boolean truth of whether arg1 is greater than arg2.

Signature

gt(arg1 Number, arg2 Number) Boolean

Parameters

Return

{{ $result := gt 7 5 }}
Result: {{ $result }}

Result: true

ge#

Description

The ge function returns the boolean truth of whether arg1 is greater than or equal arg2.

Signature

ge(arg1 Number, arg2 Number) Boolean

Parameters

Return

{{ $result := ge 5 5 }}
Result: {{ $result }}

Result: true

Math#

math.Abs#

Description The Abs method in the math space calculates the absolute value of a number. It takes one Number parameter, and returns the result as a Float64.

Signature

Abs(x Number) Float64

Parameters

Return

{{ $number := -3.5 }}
The absolute value of {{ $number }} is {{ math.Abs $number }}

The absolute value of -3.5 is 3.5

math.Add#

Description The Add method in the math space calculates the sum of multiple numbers. It takes a variadic number of Number parameters, and returns the result as a Float64.

Signature

Add(values ...Number) Float64

Parameters

Return

{{ $values := list 1 2 3 4.5 }}
The sum of the values is {{ math.Add $values... }}

The sum of the values is 10.5

math.Sub#

Description The Sub method in the math space calculates the difference between two numbers. It takes two Number parameters, and returns the result as a Float64.

Signature

Sub(Number x, Number y) Float64

Parameters

Return

{{ $minuend := 10 }}
{{ $subtrahend := 3 }}
The difference between {{ $minuend }} and {{ $subtrahend }} is {{ math.Sub $minuend $subtrahend }}

The difference between 10 and 3 is 7

math.Pow#

Description The Pow method in the math space calculates the power of one number raised to another. It takes two Number parameters, and returns the result as a Float64.

Signature

Pow(Number x, Number y) Float64

Parameters

Return

{{ $base := 2 }}
{{ $exponent := 3 }}
The result of {{ $base }}^{{ $exponent }} is {{ math.Pow $base $exponent }}

The result of 2^3 is 8

math.Mul#

Description The Mul method in the math space calculates the product of multiple numbers. It takes a variadic number of Number parameters, and returns the result as a Float64.

Signature

Mul(values ...Number) Float64

Parameters

Return

{{ $values := list 1 2 3 4.5 }}
The product of the values is {{ math.Mul $values... }}

The product of the values is 27

math.Div#

Description The Div method in the math space calculates the division of one number by another. It takes two Number parameters, and returns the result as a Float64. If the second parameter is zero, it panics with the message "division by zero".

Signature

Div(Number x, Number y) Float64

Parameters

Return

{{ $dividend := 10 }}
{{ $divisor := 2 }}
The result of dividing {{ $dividend }} by {{ $divisor }} is {{ math.Div $dividend $divisor }}

The result of dividing 10 by 2 is 5

math.Max#

Description The Max method in the math space returns the maximum of two numbers. It takes two Number parameters, and returns the result as a Float64.

Signature

Max(Number x, Number y) Float64

Parameters

Return

{{ $a := 5 }}
{{ $b := 10 }}
The maximum of {{ $a }} and {{ $b }} is {{ math.Max $a $b }}

The maximum of 5 and 10 is 10

math.Min#

Description The Min method in the math space returns the minimum of two numbers. It takes two Number parameters, and returns the result as a Float64.

Signature

Min(Number x, Number y) Float64

Parameters

Return

{{ $a := 5 }}
{{ $b := 10 }}
The minimum of {{ $a }} and {{ $b }} is {{ math.Min $a $b }}

The minimum of 5 and 10 is 5

math.Mod#

Description The Mod method in the math space calculates the modulus of one number by another. It takes two Number parameters, and returns the result as a Float64.

Signature

Mod(Number x, Number y) Float64

Parameters

Return

{{ $a := 10 }}
{{ $b := 3 }}
The modulus of {{ $a }} by {{ $b }} is {{ math.Mod $a $b }}

The modulus of 10 by 3 is 1

math.Round#

Description The Round method in the math space rounds a number to the nearest integer. It takes one Number parameter, converts it to Float64 if valid, and returns the result as a Float64.

Signature

Round(Number x) Float64

Parameters

Return

{{ $a := 3.6 }}
The rounded value of {{ $a }} is {{ math.Round $a }}

The rounded value of 3.6 is 4

math.Floor#

Description The Floor method in the math space returns the largest integer less than or equal to a given number. It takes one Number parameter, converts it to Float64 if valid, and returns the result as a Float64.

Signature

Floor(Number x) Float64

Parameters

Return

{{ $a := 3.6 }}
The floored value of {{ $a }} is {{ math.Floor $a }}

The floored value of 3.6 is 3

math.IsInt#

Description The IsInt method in the math space checks if a given value is an integer. It takes one Object parameter and returns true if the value is an integer or a string representing an integer, otherwise returns false.

Signature

IsInt(Object n) Boolean

Parameters

Return

{{ $val := 123 }}
Is {{ $val }} an integer? {{ math.IsInt $val }}

Is 123 an integer? true

math.IsFloat#

Description The IsFloat method in the math space checks if a given value is a floating-point number. It takes one Object parameter and returns true if the value is a float or a string representing a float, otherwise returns false.

Signature

IsFloat(Object n) Boolean

Parameters

Return

{{ $val := "123.45" }}
Is {{ $val }} a float? {{ math.IsFloat $val }}

Is 123.45 a float? true

math.IsNum#

Description The IsNum method in the math space checks if a given value is a number (either an integer or a float). It takes one Object parameter and returns true if the value is a number or a string representing a number, otherwise returns false.

Signature

IsNum(Object n) Boolean

Parameters

Return

{{ $val := "123.45" }}
Is {{ $val }} a number? {{ math.IsNum $val }}

Is 123.45 a number? true

String#

string.StartsWith#

Description

The StartsWith method checks if the given string starts with the specified prefix.

Signature

StartsWith(str String, prefix String) Boolean

Parameters

Return

{{ $str := "Hello, world!" }}
{{ $prefix := "Hello" }}
Starts with prefix: {{ string.StartsWith $str $prefix }}

Starts with prefix: true

string.EndsWith#

Description

The EndsWith method checks if the given string ends with the specified suffix.

Signature

EndsWith(str String, suffix String) Boolean

Parameters

Return

{{ $str := "Hello, world!" }}
{{ $suffix := "world!" }}
Ends with suffix: {{ string.EndsWith $str $suffix }}

Ends with suffix: true

string.Contains#

Description

The Contains method checks if the given string contains the specified substring.

Signature

Contains(str String, substr String) Boolean

Parameters

Return

{{ $str := "Hello, world!" }}
{{ $substr := "world" }}
Contains substring: {{ string.Contains $str $substr }}

Contains substring: true

string.ToUpperCase#

Description

The ToUpperCase method converts all characters in the given string to uppercase.

Signature

ToUpperCase(str String) String

Parameters

Return

{{ $str := "Hello, world!" }}
Uppercase: {{ string.ToUpperCase $str }}

Uppercase: HELLO, WORLD!

string.ToLowerCase#

Description

The ToLowerCase method converts all characters in the given string to lowercase.

Signature

ToLowerCase(str String) String

Parameters

Return

{{ $str := "Hello, world!" }}
Lowercase: {{ string.ToLowerCase $str }}

Lowercase: hello, world!

string.ToPascalCase#

Description

The ToPascalCase method converts the given string to PascalCase format, where each word starts with an uppercase letter and there are no spaces between words.

Signature

ToPascalCase(str String) String

Parameters

Return

{{ $str := "hello world example" }}
PascalCase: {{ string.ToPascalCase $str }}

PascalCase: HelloWorldExample

string.ToCamelCase#

Description

The ToCamelCase method converts the given string to camelCase format, where the first word is in lowercase and subsequent words start with uppercase letters, with no spaces between words.

Signature

ToCamelCase(str String) String

Parameters

Return

{{ $str := "hello world example" }}
CamelCase: {{ string.ToCamelCase $str }}

CamelCase: helloWorldExample

string.ToSnakeCase#

Description

The ToSnakeCase method converts the given String to snake_case format, where words are separated by underscores, and all letters are in lowercase.

Signature

ToSnakeCase(str String) String

Parameters

Return

{{ $str := "HelloWorldExample" }}
SnakeCase: {{ string.ToSnakeCase $str }}

SnakeCase: hello_world_example

string.ToKebabCase#

Description

The ToKebabCase method converts the given string to kebab-case format, where words are separated by hyphens, and all letters are in lowercase.

Signature

ToKebabCase(str String) String

Parameters

Return

{{ $str := "Hello World Example" }}
KebabCase: {{ string.ToKebabCase $str }}

KebabCase: hello-world-example

string.ToUpperFlatCase#

Description

The ToUpperFlatCase method converts the given string to flat case format, where all spaces are removed, and all letters are converted to uppercase.

Signature

ToUpperFlatCase(str String) String

Parameters

Return

{{ $str := "Hello World Example" }}
UpperFlatCase: {{ string.ToUpperFlatCase $str }}

UpperFlatCase: HELLOWORLDEXAMPLE

string.ToLowerFlatCase#

Description

The ToLowerFlatCase method converts the given string to flat case format, where all spaces are removed, and all letters are converted to lowercase.

Signature

ToLowerFlatCase(str String) String

Parameters

Return

{{ $str := "Hello World Example" }}
LowerFlatCase: {{ string.ToLowerFlatCase $str }}

LowerFlatCase: helloworldexample

string.ToCobolCase#

Description

The ToCobolCase method converts the given string to COBOL case format, where spaces are replaced by hyphens, and all letters are converted to uppercase.

Signature

ToCobolCase(str String) String

Parameters

Return

{{ $str := "Hello World Example" }}
CobolCase: {{ string.ToCobolCase $str }}

CobolCase: HELLO-WORLD-EXAMPLE

string.ToTrainCase#

Description

The ToTrainCase method converts the given string to Train Case format, where words are capitalized, separated by hyphens, and spaces are replaced with hyphens.

Signature

ToTrainCase(str String) String

Parameters

Return

{{ $str := "hello world example" }}
TrainCase: {{ string.ToTrainCase $str }}

TrainCase: Hello-World-Example

string.ToNormalCase#

Description

The ToNormalCase method converts the given string to a more natural format, where hyphens and underscores are replaced by spaces, and each word is capitalized.

Signature

ToNormalCase(str String) String

Parameters

Return

{{ $str := "hello-world_example" }}
NormalCase: {{ string.ToNormalCase $str }}

NormalCase: Hello World Example

string.Normalize#

Description

The Normalize method replaces newline characters with spaces and trims leading and trailing spaces from the given string.

Signature

Normalize(str String) String

Parameters

Return

{{ $str := "  Hello\nWorld  " }}
Normalized: {{ string.Normalize $str }}

Normalized: Hello World

string.TrimSpace#

Description

The TrimSpace method removes leading and trailing white space characters from the given string.

Signature

TrimSpace(str String) String

Parameters

Return

{{ $str := "  Hello World  " }}
Trimmed: {{ string.TrimSpace $str }}

Trimmed: Hello World

string.Trim#

Description

The Trim method removes all leading and trailing occurrences of the specified cutset characters from the given string.

Signature

Trim(str String, cutset String) String

Parameters

Return

{{ $str := "***Hello World***" }}
Trimmed: {{ string.Trim $str "*" }}

Trimmed: Hello World

string.TrimSuffix#

Description

The TrimSuffix method removes the specified suffix characters from the end of the given string.

Signature

TrimSuffix(str String, cutset String) String

Parameters

Return

{{ $str := "Hello World!!!" }}
Trimmed: {{ string.TrimSuffix $str "!" }}

Trimmed: Hello World

string.TrimPrefix#

Description

The TrimPrefix method removes the specified prefix characters from the start of the given string.

Signature

TrimPrefix(str String, cutset String) string

Parameters

Return

{{ $str := "!!!Hello World" }}
Trimmed: {{ string.TrimPrefix $str "!" }}

Trimmed: Hello World

string.Replace#

Description

The Replace method replaces occurrences of the old substring with the new substring in the given string, up to a specified number of replacements.

Signature

Replace(str String, old String, new String, n Int) String

Parameters

Return

{{ $str := "foo foo foo" }}
Replaced: {{ string.Replace $str "foo" "bar" 2 }}

Replaced: bar bar foo

string.Split#

Description

The Split method splits the given string into a slice of substrings separated by the specified separator.

Signature

Split(str String, sep String) []String

Parameters

Return

{{ $str := "a,b,c" }}
Split: {{ string.Split $str "," }}

Split: [a b c]

string.Concat#

Description

The Concat method concatenates a slice of strings into a single string, separated by the specified separator.

Signature

Concat(sep String, items ...String) String

Parameters

Return

{{ $items := list "a" "b" "c" }}
Concatenated: {{ string.Concat "," $items }}

Concatenated: a,b,c

string.Repeat#

Description

The Repeat method repeats the given string a specified number of times.

Signature

Repeat(str String, count Int) String

Parameters

Return

{{ $str := "Pars" }}
Repeated: {{ string.Repeat $str 3 }}

Repeated: ParsParsPars

string.JoinFields#

Description

The JoinFields method joins the fields of a slice of structs or simple values into a single string, separated by the specified separator. If the slice contains structs, it extracts the value of the specified field.

Signature

JoinFields(slice []Object, sep String, key String) String

Parameters

Return

{{ $items := list (struct "Name" "Alice") (struct "Name" "Bob") }}
Joined Fields: {{ string.JoinFields $items "," "Name" }}

Joined Fields: Alice,Bob

string.SplitFields#

Description

The SplitFields method splits the given string into a slice of interfaces using the specified separator.

Signature

SplitFields(input String, sep String) []String

Parameters

Return

{{ $input := "a,b,c" }}
Split Fields: {{ string.SplitFields $input "," }}

Split Fields: [a b c]

string.Pluralize #

Description

The Pluralize method returns the plural form of the given word. It handles irregular plurals and applies common English pluralization rules.

Signature

Pluralize(word String) String

Parameters

Return

{{ $word := "child" }}
Pluralized: {{ string.Pluralize $word }}

Pluralized: children

string.UnPluralize #

Description

The UnPluralize method returns the singular form of the given plural word. It handles irregular plurals and applies common English singularization rules.

Signature

UnPluralize(word String) String

Parameters

Return

{{ $word := "children" }}
Singularized: {{ string.UnPluralize $word }}

Singularized: child

string.Indent#

Description

The Indent method adds a specified indentation to the beginning of each line in the given text. It preserves the existing content of the lines and adds the indentation before each line.

Signature

Indent(text String, indent String) String

Parameters

Return

{{ $text := "line1\nline2" }}
{{ $indent := "    " }}
Indented: {{ string.Indent $text $indent }}

Indented: 
    line1
    line2

string.IndentAuto#

Description

The IndentAuto method automatically adds the existing indentation from the first line of the text to all lines in the text. If the text has no lines, it returns the original text.

Signature

IndentAuto(text String) String

Parameters

Return

{{ $text := "  line1\n  line2" }}
Auto Indented: {{ string.IndentAuto $text }}

Auto Indented: 
    line1
    line2

string.ArrayToStringSlice#

Description

The ArrayToStringSlice method converts an array of []Object to a slice of strings, filtering out any non-string values.

Signature

ArrayToStringSlice(arr []Object) []string

Parameters

Return

{{ $arr := slice "one" 2 "three" }}
String Slice: {{ string.ArrayToStringSlice $arr }}

String Slice: [one three]

Regexp#

regexp.Find#

Description

The Find method searches for the first occurrence of the regular expression expression within the input string and returns the matching substring.

Signature

Find(expression String, input String) String

Parameters

Return

{{ $pattern := "\\d+" }}
{{ $input := "The price is 42 dollars." }}
{{ $match, $err := regex.Find $pattern $input }}
{{ if $err }}
    <p>Error: {{ $err }}</p>
{{ else }}
    <p>Match: {{ $match }}</p>
{{ end }}

Match: 42

regexp.FindAll#

Description

The FindAll method in the regexp type searches for all occurrences of a regular expression pattern within a given input string. It returns up to n matches.

Signature

FindAll(expression String, n Int, input String) []String

Parameters

Return

{{ $expression := "\\d+" }}
{{ $input := "The prices are 20, 30, and 40 dollars." }}
{{ $matches := regex.FindAll $expression 3 $input }}
Matches found: {{ $matches }}

Matches found: [20 30 40]

regexp.Match#

Description

The Match method in the regexp space checks if the input string matches the given regular expression. It returns a boolean indicating whether the match was successful and an error if the regular expression compilation fails.

Signature

Match(expression String, input String) Boolean

Parameters

Return

{{ $expression := "^Hello" }}
{{ $input := "Hello, world!" }}
Does the input match? {{ regex.Match $expression $input }}

Does the input match? true

regexp.QuoteMeta#

Description

The QuoteMeta method returns a string with all the special characters escaped. This is useful when you need to use a literal string as a regular expression.

Signature

QuoteMeta(input String) String

Parameters

Return

{{ $input := "Hello.*World" }}
Quoted meta: {{ regex.QuoteMeta $input }}

Quoted meta: Hello.\*World

regexp.Replace#

Description

The Replace method replaces all occurrences of the regular expression pattern in the input string with the replacement string.

Signature

Replace(expression String, replacement String, input String) String

Parameters

Return

{{ $expression := "world" }}
{{ $replacement := "universe" }}
{{ $input := "Hello, world!" }}
Replaced: {{ regex.Replace $expression $replacement $input }}

Replaced: Hello, universe!

regexp.ReplaceLiteral#

Description

The ReplaceLiteral method performs a literal replacement of all occurrences of the pattern in the input string with the replacement string. Unlike Replace, this does not interpret the pattern as a regular expression.

Signature

ReplaceLiteral(expression String, replacement String, input String) String

Parameters

Return

{{ $expression := "world" }}
{{ $replacement := "universe" }}
{{ $input := "Hello, world!" }}
Replaced literal: {{ regex.ReplaceLiteral $expression $replacement $input }}

Replaced literal: Hello, universe!

regexp.Split#

Description

The Split method splits the input string around each match of the regular expression. The n parameter controls the number of substrings to return.

Signature

Split(expression String, n Int, input String) []String

Parameters

Return

{{ $expression := "\\s" }}
{{ $n := 2 }}
{{ $input := "Hello world from Pars" }}
Split result: {{ regex.Split $expression $n $input }}

Split result: [Hello world from Pars]

Array#

array.Slice#

Description

The Slice method in the array space takes a variable number of arguments and returns them as a slice of interface{}. This is useful for creating slices from a list of values within a template.

Signature

Slice(args ...Object) []Object

Parameters

Return

{{ $a := 1 }}
{{ $b := "two" }}
{{ $c := 3.0 }}
The slice contains: {{ array.Slice $a $b $c }}

The slice contains: [1 two 3]

array.Has#

Description

The Has method in the array space checks if a map, slice, or array contains a specific key or value. It takes two Object parameters: the collection and the key or value to check for, and returns true if the key or value is found, otherwise returns false.

Signature

Has(in []Object, key String) Boolean

Parameters

Return

{{ $list := slice "one" "two" "three" }}
Does the list contain "two"? {{ array.Has $list "two" }}

Does the list contain "two"? true

array.Append#

Description

The Append method in the array space adds an element to the end of a slice. It takes two Object parameters: the value to append and the slice to append to, and returns the updated slice.

Signature

Append(v Object, list []Object) []Object

Parameters

Return

{{ $list := slice "one" "two" }}
The updated list is: {{ array.Append "three" $list }}

The updated list is: [one two three]

array.Prepend#

Description

The Prepend method in the array space adds an element to the beginning of a slice. It takes two Object parameters: the value to prepend and the slice to prepend to, and returns the updated slice.

Signature

Prepend(v Object, list Object) []Object

Parameters

Return

{{ $list := slice "one" "two" }}
The updated list is: {{ array.Prepend "zero" $list }}

The updated list is: [zero one two]

array.Uniq#

Description

The Uniq method in the array space removes duplicate elements from a slice. It takes one Object parameter: the slice to process, and returns a new slice with duplicates removed.

Signature

Uniq(list []Object) []Object

Parameters

Return

{{ $list := slice "one" "two" "one" "three" "two" }}
The unique list is: {{ array.Uniq $list }}

The unique list is: [one two three]

array.Reverse#

Description

The Reverse method in the array space reverses the order of elements in a slice. It takes one Object parameter: the slice to reverse, and returns a new slice with the elements in reverse order.

Signature

Reverse(list []Object) []Object

Parameters

Return

{{ $list := slice "one" "two" "three" }}
The reversed list is: {{ array.Reverse $list }}

The reversed list is: [three two one]

array.Sort#

Description

The Sort method in the array space sorts a slice of elements based on a specified key. It takes two Object parameters: the key to sort by and the slice to sort. It returns a new sorted slice and an error if the operation fails.

Signature

Sort(key String, list []Object) []Object

Parameters

Return

{{ $list := slice (dict "name" "Alice" "age" 30) (dict "name" "Bob" "age" 25) (dict "name" "Charlie" "age" 35) }}
The sorted list by age is: {{ array.Sort "age" $list }}

The sorted list by age is: [{name:Bob age:25} {name:Alice age:30} {name:Charlie age:35}]

array.Flatten#

Description

The Flatten method in the array space flattens a nested slice or array up to a specified depth. It takes two parameters: the slice or array to flatten and the depth to which to flatten it. It returns a new flattened slice and an error if the operation fails.

Signature

Flatten(list []Object, depth Int) []Object

Parameters

Return

{{ $nestedList := slice (slice 1 2) (slice 3 (slice 4 5)) 6 }}
The flattened list is: {{ array.Flatten $nestedList 1 }}

The flattened list is: [1 2 3 [4 5] 6]

array.IsFirst#

Description

The IsFirst method in the array space checks if a given index is the first position (i.e., index 0) in a slice. It takes two parameters: the index and the slice to check. It returns true if the index is 0, otherwise false.

Signature

IsFirst(index Int, slice []Object) Boolean

Parameters

Return

{{ $list := slice "a" "b" "c" }}
Is index 0 the first? {{ array.IsFirst 0 $list }}

Is index 0 the first? true

array.IsLast#

Description

The IsLast method in the array space checks if a given index is the last position in a slice. It takes two parameters: the index and the slice to check. It returns true if the index is the last position, otherwise false.

Signature

IsLast(index Int, slice []Object) Boolean

Parameters

Return

{{ $list := slice "a" "b" "c" }}
Is index 2 the last? {{ array.IsLast 2 $list }}

Is index 2 the last? true

array.HasElements#

Description

The HasElements method in the array space checks if a slice contains any elements. It takes one parameter: the slice to check. It returns true if the slice has more than 0 elements, otherwise false.

Signature

HasElements(slice []Object) Boolean

Parameters

Return

{{ $list := slice "a" "b" "c" }}
Does the list have elements? {{ array.HasElements $list }}