Name
Functions — built-in functions to call within expressions
contains
contains(object, value)
Returns true if the object contains the specified
value. If the object is a string, a substring is searched for the value. If
the object is a collection or array, its elements are searched for the
value.
Parameters
- object
-
the object to be searched for the presence of.
- value
-
the value to be searched for.
Returns
- true
-
if the object contains the specified value.
indexOf
indexOf(string, substring)
Returns the index within a string of the first occurrence of a specified substring.
Parameters
- string
-
the string to be searched.
- substring
-
the value to search for within the string.
Returns
-
the index of the first instance of substring, or -1 if not found.
join
join(strings, separator)
Joins an array of strings into a single string value, with a specified separator.
Parameters
- separator
-
the separator to place between joined elements.
- strings
-
the array of strings to be joined.
Returns
-
the string containing the joined strings.
keyMatch
keyMatch(map, pattern)
Returns the first key found in a map that matches the specified regular expression pattern, or null if no such
match is found.
Parameters
- map
-
the map whose keys are to be searched.
- pattern
-
a string containing the regular expression pattern to match.
Returns
-
the first matching key, or
nullif no match found.
length
length(object)
Returns the number of items in a collection, or the number of characters in a string.
Parameters
- object
-
the object whose length is to be determined.
Returns
-
the length of the object, or 0 if length could not be determined.
matches
matches(string, pattern)
Returns an array of matching groups for a regular expression pattern against a string, or
null if no such match is found. The first element of the
array is the entire match, and each subsequent element correlates to any
capture group specified within the regular expression.
Parameters
- string
-
the string to be searched.
- pattern
-
a string containing the regular expression pattern to match.
Returns
-
an array of matching groups, or
nullif no such match is found.
split
split(string, pattern)
Splits a string into an array of substrings around matches of the given regular expression pattern.
Parameters
- string
-
the string to be split.
- pattern
-
the regular expression to split substrings around.
Returns
-
the resulting array of split substrings.
toLowerCase
toLowerCase(string)
Converts all of the characters in a string to lower case.
Parameters
- string
-
the string whose characters are to be converted.
Returns
-
the string with characters converted to lower case.
toString
toString(object)
Returns the string value of an aribtrary object.
Parameters
- object
-
the object whose string value is to be returned.
Returns
-
the string value of the object.
toUpperCase
toUpperCase(string)
Converts all of the characters in a string to upper case.
Parameters
- string
-
the string whose characters are to be converted.
Returns
-
the string with characters converted to upper case.
