Functions

abs

If the given number is negative then returns its positive equivalent, or otherwise returns the given number unchanged.

abs(num)

Parameter	Type	Description
num	number

can

can(expression)

Parameter	Type	Description
expression	expression closure

ceil

Returns the smallest whole number that is greater than or equal to the given value.

ceil(num)

Parameter	Type	Description
num	number

chomp

Removes one or more newline characters from the end of the given string.

chomp(str)

Parameter	Type	Description
str	string

chunklist

Splits a single list into multiple lists where each has at most the given number of elements.

chunklist(list, size)

Parameter	Type	Description
list	list of dynamic	The list to split into chunks.
size	number	The maximum length of each chunk. All but the last element of the result is guaranteed to be of exactly this size.

coalescelist

Returns the first of the given sequences that has a length greater than zero.

coalescelist(…vals)

Parameter	Type	Description
vals	dynamic	List or tuple values to test in the given order.

compact

Removes all empty string elements from the given list of strings.

compact(list)

Parameter	Type	Description
list	list of string

concat

Concatenates together all of the given lists or tuples into a single sequence, preserving the input order.

concat(…seqs)

Parameter	Type	Description
seqs	dynamic

contains

Returns true if the given value is a value in the given list, tuple, or set, or false otherwise.

contains(list, value)

Parameter	Type	Description
list	dynamic
value	dynamic

csvdecode

Parses the given string as Comma Separated Values (as defined by RFC 4180) and returns a map of objects representing the table of data, using the first row as a header row to define the object attributes.

csvdecode(str)

Parameter	Type	Description
str	string

distinct

Removes any duplicate values from the given list, preserving the order of remaining elements.

distinct(list)

Parameter	Type	Description
list	list of dynamic

element

Returns the element with the given index from the given list or tuple, applying the modulo operation to the given index if it's greater than the number of elements.

element(list, index)

Parameter	Type	Description
list	dynamic
index	number

endswith

endswith(s, suffix)

Parameter	Type	Description
s	string
suffix	string

flatten

Transforms a list, set, or tuple value into a tuple by replacing any given elements that are themselves sequences with a flattened tuple of all of the nested elements concatenated together.

flatten(list)

Parameter	Type	Description
list	dynamic

floor

Returns the greatest whole number that is less than or equal to the given value.

floor(num)

Parameter	Type	Description
num	number

format

Constructs a string by applying formatting verbs to a series of arguments, using a similar syntax to the C function "printf".

format(format, …args)

Parameter	Type	Description
format	string
args	dynamic

formatdate

Formats a timestamp given in RFC 3339 syntax into another timestamp in some other machine-oriented time syntax, as described in the format string.

formatdate(format, time)

Parameter	Type	Description
format	string
time	string

formatlist

Constructs a list of strings by applying formatting verbs to a series of arguments, using a similar syntax to the C function "printf".

formatlist(format, …args)

Parameter	Type	Description
format	string
args	dynamic

indent

Adds a given number of spaces after each newline character in the given string.

indent(spaces, str)

Parameter	Type	Description
spaces	number	Number of spaces to add after each newline character.
str	string	The string to transform.

index

Returns the element with the given key from the given collection, or raises an error if there is no such element.

index(collection, key)

Parameter	Type	Description
collection	dynamic
key	dynamic

join

Concatenates together the elements of all given lists with a delimiter, producing a single string.

join(separator, …lists)

Parameter	Type	Description
separator	string	Delimiter to insert between the given strings.
lists	list of string	One or more lists of strings to join.

jsondecode

Parses the given string as JSON and returns a value corresponding to what the JSON document describes.

jsondecode(str)

Parameter	Type	Description
str	string

jsonencode

Returns a string containing a JSON representation of the given value.

jsonencode(val)

Parameter	Type	Description
val	dynamic

keys

Returns a list of the keys of the given map in lexicographical order.

keys(inputMap)

Parameter	Type	Description
inputMap	dynamic	The map to extract keys from. May instead be an object-typed value, in which case the result is a tuple of the object attributes.

length

Returns the number of elements in the given collection.

length(collection)

Parameter	Type	Description
collection	dynamic

list

list(elem_type)

Parameter	Type	Description
elem_type	type

log

Returns the logarithm of the given number in the given base.

log(num, base)

Parameter	Type	Description
num	number
base	number

lower

Returns the given string with all Unicode letters translated to their lowercase equivalents.

lower(str)

Parameter	Type	Description
str	string

map

map(elem_type)

Parameter	Type	Description
elem_type	type

max

Returns the numerically greatest of all of the given numbers.

max(…numbers)

Parameter	Type	Description
numbers	number

merge

Merges all of the elements from the given maps into a single map, or the attributes from given objects into a single object.

merge(…maps)

Parameter	Type	Description
maps	dynamic

min

Returns the numerically smallest of all of the given numbers.

min(…numbers)

Parameter	Type	Description
numbers	number

object

object(attr_type)

Parameter	Type	Description
attr_type	map of type

parseint

Parses the given string as a number of the given base, or raises an error if the string contains invalid characters.

parseint(number, base)

Parameter	Type	Description
number	dynamic
base	number

pow

Returns the given number raised to the given power (exponentiation).

pow(num, power)

Parameter	Type	Description
num	number
power	number

print

print prints the value to stdout, and returns the value.

print(print)

Parameter	Type	Description
print	dynamic

range

Returns a list of numbers spread evenly over a particular range.

range(…params)

Parameter	Type	Description
params	number

regex

Applies the given regular expression pattern to the given string and returns information about a single match, or raises an error if there is no match.

regex(pattern, string)

Parameter	Type	Description
pattern	string
string	string

regexall

Applies the given regular expression pattern to the given string and returns a list of information about all non-overlapping matches, or an empty list if there are no matches.

regexall(pattern, string)

Parameter	Type	Description
pattern	string
string	string

regexpescape

Return a string that escapes all regular expression metacharacters in the provided text.

regexpescape(str)

Parameter	Type	Description
str	string

regexreplace

Applies the given regular expression pattern to the given string and replaces all matches with the given replacement string.

regexreplace(str, pattern, replace)

Parameter	Type	Description
str	string
pattern	string
replace	string

replace

Replaces all instances of the given substring in the given string with the given replacement string.

replace(str, substr, replace)

Parameter	Type	Description
str	string	The string to search within.
substr	string	The substring to search for.
replace	string	The new substring to replace substr with.

reverse

Returns the given list with its elements in reverse order.

reverse(list)

Parameter	Type	Description
list	dynamic

set

set(elem_type)

Parameter	Type	Description
elem_type	type

setintersection

Returns the intersection of all given sets.

setintersection(first_set, …other_sets)

Parameter	Type	Description
first_set	set of dynamic
other_sets	set of dynamic

setproduct

Calculates the cartesian product of two or more sets.

setproduct(…sets)

Parameter	Type	Description
sets	dynamic	The sets to consider. Also accepts lists and tuples, and if all arguments are of list or tuple type then the result will preserve the input ordering

setsubtract

Returns the relative complement of the two given sets.

setsubtract(a, b)

Parameter	Type	Description
a	set of dynamic
b	set of dynamic

setunion

Returns the union of all given sets.

setunion(first_set, …other_sets)

Parameter	Type	Description
first_set	set of dynamic
other_sets	set of dynamic

signum

Returns 0 if the given number is zero, 1 if the given number is positive, or -1 if the given number is negative.

signum(num)

Parameter	Type	Description
num	number

slice

Extracts a subslice of the given list or tuple value.

slice(list, start_index, end_index)

Parameter	Type	Description
list	dynamic
start_index	number
end_index	number

sort

Applies a lexicographic sort to the elements of the given list.

sort(list)

Parameter	Type	Description
list	list of string

split

Produces a list of one or more strings by splitting the given string at all instances of a given separator substring.

split(separator, str)

Parameter	Type	Description
separator	string	The substring that delimits the result strings.
str	string	The string to split.

sql

sql is a stub function for raw expressions.

sql(def)

Parameter	Type	Description
def	string

startswith

startswith(s, prefix)

Parameter	Type	Description
s	string
prefix	string

strrev

Returns the given string with all of its Unicode characters in reverse order.

strrev(str)

Parameter	Type	Description
str	string

substr

Extracts a substring from the given string.

substr(str, offset, length)

Parameter	Type	Description
str	string	The input string.
offset	number	The starting offset in Unicode characters.
length	number	The maximum length of the result in Unicode characters.

timeadd

Adds the duration represented by the given duration string to the given RFC 3339 timestamp string, returning another RFC 3339 timestamp.

timeadd(timestamp, duration)

Parameter	Type	Description
timestamp	string
duration	string

title

Replaces one letter after each non-letter and non-digit character with its uppercase equivalent.

title(str)

Parameter	Type	Description
str	string

tobool

tobool(v)

Parameter	Type	Description
v	dynamic

tolist

tolist(v)

Parameter	Type	Description
v	dynamic

tonumber

tonumber(v)

Parameter	Type	Description
v	dynamic

toset

toset(v)

Parameter	Type	Description
v	dynamic

tostring

tostring(v)

Parameter	Type	Description
v	dynamic

trim

Removes consecutive sequences of characters in "cutset" from the start and end of the given string.

trim(str, cutset)

Parameter	Type	Description
str	string	The string to trim.
cutset	string	A string containing all of the characters to trim. Each character is taken separately, so the order of characters is insignificant.

trimprefix

Removes the given prefix from the start of the given string, if present.

trimprefix(str, prefix)

Parameter	Type	Description
str	string	The string to trim.
prefix	string	The prefix to remove, if present.

trimspace

Removes any consecutive space characters (as defined by Unicode) from the start and end of the given string.

trimspace(str)

Parameter	Type	Description
str	string

trimsuffix

Removes the given suffix from the start of the given string, if present.

trimsuffix(str, suffix)

Parameter	Type	Description
str	string	The string to trim.
suffix	string	The suffix to remove, if present.

try

try(…expressions)

Parameter	Type	Description
expressions	expression closure

tuple

tuple(elem_type)

Parameter	Type	Description
elem_type	list of type

upper

Returns the given string with all Unicode letters translated to their uppercase equivalents.

upper(str)

Parameter	Type	Description
str	string

urlescape

urlescape escapes the string so it can be safely placed inside a URL query.

urlescape(string)

Parameter	Type	Description
string	string

urlqueryset

urlqueryset sets the query parameter for the URL.

urlqueryset(url, key, value)

Parameter	Type	Description
url	string
key	string
value	string

urlsetpath

urlsetpath sets the path for the URL.

urlsetpath(url, path)

Parameter	Type	Description
url	string
path	string

urluserinfo

urluserinfo sets the user for the URL.

urluserinfo(url, user, …pass)

Parameter	Type	Description
url	string
user	string
pass	string

values

Returns the values of elements of a given map, or the values of attributes of a given object, in lexicographic order by key or attribute name.

values(mapping)

Parameter	Type	Description
mapping	dynamic

zipmap

Constructs a map from a list of keys and a corresponding list of values, which must both be of the same length.

zipmap(keys, values)

Parameter	Type	Description
keys	list of string
values	dynamic