CONCAT
Take an arbitrary number of strings and join them together.
Declaration
CONCAT() -> outputString
Parameters
Return Values
outputString - string - A string created by joining all the input strings.
JOIN
Combine a list of strings.
Declaration
JOIN(listOfStrings, separator) -> combinedString
Parameters
listOfStrings - array - A list of strings.
separator - string - A string to be placed in between each of the strings in `listOfStrings`.
Return Values
combinedString - string - String created by joining all of the strings with the separator between them.
LOWERCASE
Return a new string by converting all capital letters to lowercase.
Declaration
LOWERCASE(baseString) -> lowerCaseString
Parameters
baseString - string - A string containing any casing of characters.
Return Values
lowerCaseString - string - String created by changing all upper case characters in the base string to their lower case equivalents.
REPLACE
Replace part of a string with a replacement string.
Declaration
REPLACE(inputString, replacement, search) -> finalString
REPLACE(inputString, replacement, start, end) -> finalString
Parameters
inputString - string - Base string to start with.
replacement - string - string to insert at the insertion point.
search - string - If type is string it is the search string to replace with replacement in the base string. If a number it is the start position (0 based) in the base string to replace.
start - string - If type is string it is the search string to replace with replacement in the base string. If a number it is the start position (0 based) in the base string to replace.
end - number - This schema species that end is required when start is a number.
Return Values
finalString - string - This is the resulting string from taking the base and replacing the search string with the replacement string or from start to end indexes. Replaces only the first index.
SPLIT
Given a string and a separator, return a list of strings broken by the separator.
Declaration
SPLIT(baseString, separator) -> listOfStrings
Parameters
baseString - string - The string to split.
separator - string - String to use as the separator.
Return Values
listOfStrings - array - The resulting list of strings by taking the base string and splitting it by the separator.
STRING_COMPARE
Used to compare strings and return their lexical order.
Declaration
STRING_COMPARE(string1, string2) -> comparisonReturn
Parameters
string1 - string - The first string.
string2 - string - The second string.
Return Values
comparisonReturn - number - 0 if the strings are identical. Negative if string1 is before string2. 1 if string2 is bfore string1.
SUBSTRING
Get the substring of from a string starting at a given index.
Declaration
SUBSTRING(baseString, start, end) -> substring
Parameters
baseString - string - The base string to pull the substring out of.
start - number - Number value for the start position.
end - number - Optional. End index to end the substring, if not provided it will take to the end of the string.
Return Values
substring - string - The resulting substring taken from the baseString starting at the start index and ending at the end index or the end of the baseString.
TITLECASE
Return a string by converting the first character of each space separated word of the input string to upper case. Capital letters will be left as they are.
Declaration
TITLECASE(string) -> titleCasedString
Parameters
string - string - Any string.
Return Values
titleCasedString - string - The input string reformatted in Title Case.
TRIM
Return the leading and trailing whitespace from a string.
Declaration
TRIM(inputString) -> trimmedString
Parameters
inputString - string - Any string.
Return Values
trimmedString - string - The input string minus any leading or trailing whitespace.
UPPERCASE
Return the lowercase representation of a string.
Declaration
UPPERCASE(baseString) -> upperCaseString
Parameters
baseString - string - A string containing any casing of characters.
Return Values
upperCaseString - string - String created by changing all lower case characters in the base string to their upper case equivalents.