CONCAT

CONCAT concatenates one or more instances of String, or an Array.


Argument	Type	Default value	Description
`src`	`String, repeated` `String[]`		The source string / array.

Returns String A string value.

CONCAT_SEPARATOR

Source

CONCAT_SEPARATOR concatenates one or more instances of String, or an Array with a given separator.


Argument	Type	Default value	Description
`separator`	`String`		The separator string.
`src`	`String, repeated` `String[]`		The source string / array.

Returns String Concatenated string.

CONTAINS

Source

CONTAINS returns a value indicating whether a specified substring occurs within a string.


Argument	Type	Default value	Description
`str`	`String`		The source string.
`search`	`String`		The string to seek.
`returnIndex`	`Boolean`	`False`	Values which indicates whether to return the character position of the match is returned instead of a boolean.

Returns Boolean Int A value indicating whether a specified substring occurs within a string.

DECODE_URI_COMPONENT

Source

DECODE_URI_COMPONENT returns the decoded String of uri.


Argument	Type	Default value	Description
`uri`	`String`		Uri to decode.

Returns String Decoded string.

ENCODE_URI_COMPONENT

Source

ENCODE_URI_COMPONENT returns the encoded String of uri.


Argument	Type	Default value	Description
`uri`	`String`		Uri to encode.

Returns String Encoded string.

ESCAPE_HTML

Source

“ESCAPE_HTML escapes special characters like "<" to become "<". It escapes only five such characters: <, >, &, ’ and ". UnescapeString(EscapeString(s))\ == s always holds, but the converse isn’t always true.”


Argument	Type	Default value	Description
`uri`	`String`		Uri to escape.

Returns String Escaped string.

FIND_FIRST

Source

FIND_FIRST returns the position of the first occurrence of the string search inside the string text. Positions start at 0.


Argument	Type	Default value	Description
`str`	`String`		The source string.
`search`	`String`		The string to seek.
`start`	`Int`		Limit the search to a subset of the text, beginning at start.
`end`	`Int`		Limit the search to a subset of the text, ending at end

Returns Int The character position of the match. if search is not contained in text, -1 is returned. if search is empty, start is returned.

FIND_LAST

Source

FIND_LAST returns the position of the last occurrence of the string search inside the string text. Positions start at 0.


Argument	Type	Default value	Description
`src`	`String`		The source string.
`search`	`String`		The string to seek.
`start`	`Int`		Limit the search to a subset of the text, beginning at start.
`end`	`Int`		Limit the search to a subset of the text, ending at end

Returns Int The character position of the match. if search is not contained in text, -1 is returned. if search is empty, start is returned.

FMT

Source

FMT formats the template using these arguments.


Argument	Type	Default value	Description
`template`	`String`		Template.
`args`	`Any, repeated`		Template arguments.

Returns String String formed by template using arguments.

FROM_BASE64

Source

FROM_BASE64 returns the value of a base64 representation.


Argument	Type	Default value	Description
`str`	`String`		The string to decode.

Returns String The decoded string.

JSON_PARSE

Source

JSON_PARSE returns a value described by the JSON-encoded input string.


Argument	Type	Default value	Description
`str`	`String`		The string to parse as json.

Returns Any Parsed value.

JSON_STRINGIFY

Source

JSON_STRINGIFY returns a JSON string representation of the input value.


Argument	Type	Default value	Description
`str`	`Any`		The input value to serialize.

Returns String Json string.

LEFT

Source

LEFT returns the leftmost characters of the string value by index.


Argument	Type	Default value	Description
`str`	`String`		The source string.
`length`	`Int`		The amount of characters to return.

Returns String The leftmost characters of the string value by index.

LIKE

Source

LIKE checks whether the pattern search is contained in the string text, using wildcard matching.


Argument	Type	Default value	Description
`str`	`String`		The string to search in.
`search`	`String`		A search pattern that can contain the wildcard characters.
`caseInsensitive - If set to true, the matching will be case`	`Boolean`		Insensitive. the default is false.

Returns Boolean Returns true if the pattern is contained in text, and false otherwise.

LOWER

Source

LOWER converts strings to their lower-case counterparts. All other characters are returned unchanged.


Argument	Type	Default value	Description
`str`	`String`		The source string.

Returns String This string in lower case.

LTRIM

Source

LTRIM returns the string value with whitespace stripped from the start only.


Argument	Type	Default value	Description
`str`	`String`		The string.
`chars`	`String`		Overrides the characters that should be removed from the string. it defaults to \r\n \t.

Returns String The string without chars at the left-hand side.

MD5

Source

MD5 calculates the MD5 checksum for text and return it in a hexadecimal string representation.


Argument	Type	Default value	Description
`str`	`String`		The string to do calculations against to.

Returns String Md5 checksum as hex string.

RANDOM_TOKEN

Source

RANDOM_TOKEN generates a pseudo-random token string with the specified length. The algorithm for token generation should be treated as opaque.


Argument	Type	Default value	Description
`len`	`Int`		The desired string length for the token. it must be greater than 0 and at most 65536.

Returns String A generated token consisting of lowercase letters, uppercase letters and numbers.

REGEX_MATCH

Source

REGEX_MATCH returns the matches in the given string text, using the regex.


Argument	Type	Default value	Description
`str`	`String`		The string to search in.
`expression`	`String`		A regular expression to use for matching the text.
`caseInsensitive - If set to true, the matching will be case`	`Boolean`		Insensitive. the default is false.

Returns Any[] An array of strings containing the matches.

REGEX_REPLACE

Source

REGEX_REPLACE replace every substring matched with the regexp with a given string.


Argument	Type	Default value	Description
`str`	`String`		The string to split.
`expression`	`String`		A regular expression search pattern.
`replacement`	`String`		The string to replace the search pattern with
`caseInsensitive`	`Boolean`	`False`	Insensitive.

Returns String Returns the string text with the search regex pattern replaced with the replacement string wherever the pattern exists in text

REGEX_SPLIT

Source

REGEX_SPLIT splits the given string text into a list of strings, using the separator.


Argument	Type	Default value	Description
`str`	`String`		The string to split.
`expression`	`String`		A regular expression to use for splitting the text.
`caseInsensitive - If set to true, the matching will be case`	`Boolean`		Insensitive. the default is false.
`limit`	`Int`		Limit the number of split values in the result. if no limit is given, the number of splits returned is not bounded.

Returns Any[] An array of strings splitted by the expression.

REGEX_TEST

Source

REGEX_TEST test whether the regexp has at least one match in the given text.


Argument	Type	Default value	Description
`str`	`String`		The string to test.
`expression`	`String`		A regular expression to use for splitting the text.
`caseInsensitive`	`Boolean`	`False`	Insensitive.

Returns Boolean Returns true if the pattern is contained in text, and false otherwise.

RIGHT

Source

RIGHT returns the rightmost characters of the string value.


Argument	Type	Default value	Description
`str`	`String`		The source string.
`length`	`Int`		The amount of characters to return.

Returns String The rightmost characters of the string value.

RTRIM

Source

RTRIM returns the string value with whitespace stripped from the end only.


Argument	Type	Default value	Description
`str`	`String`		The string.
`chars`	`String`		Overrides the characters that should be removed from the string. it defaults to \r\n \t.

Returns String The string without chars at the right-hand side.

SHA1

Source

SHA1 calculates the SHA1 checksum for text and returns it in a hexadecimal string representation.


Argument	Type	Default value	Description
`str`	`String`		The string to do calculations against to.

Returns String Sha1 checksum as hex string.

SHA512

Source

SHA512 calculates the SHA512 checksum for text and returns it in a hexadecimal string representation.


Argument	Type	Default value	Description
`str`	`String`		The string to do calculations against to.

Returns String Sha512 checksum as hex string.

SPLIT

Source

SPLIT splits the given string value into a list of strings, using the separator.


Argument	Type	Default value	Description
`str`	`String`		The string to split.
`separator`	`String`		The separator.
`limit`	`Int`		Limit the number of split values in the result. if no limit is given, the number of splits returned is not bounded.

Returns String[] Array of strings.

SUBSTITUTE

Source

SUBSTITUTE replaces search values in the string value.


Argument	Type	Default value	Description
`str`	`String`		The string to modify
`search`	`String`		The string representing a search pattern
`replace`	`String`		The string representing a replace value
`limit`	`Int`		The cap the number of replacements to this value.

Returns String Returns a string with replace substring.

SUBSTRING

Source

SUBSTRING returns a substring of value.


Argument	Type	Default value	Description
`str`	`String`		The source string.
`offset`	`Int`		Start at offset, offsets start at position 0.
`length`	`Int`		At most length characters, omit to get the substring from offset to the end of the string.

Returns String A substring of value.

TO_BASE64

Source

TO_BASE64 returns the base64 representation of value.


Argument	Type	Default value	Description
`str`	`String`		The string to encode.

Returns String A base64 representation of the string.

TRIM

Source

TRIM returns the string value with whitespace stripped from the start and/or end.


Argument	Type	Default value	Description
`str`	`String`		The string.
`chars`	`String`		Overrides the characters that should be removed from the string. it defaults to \r\n \t.

Returns String The string without chars on both sides.

UNESCAPE_HTML

Source

UNESCAPE_HTML unescapes entities like “<” to become “<”. It unescapes a larger range of entities than EscapeString escapes. For example, “á” unescapes to “á”, as does “á” and “á”. UnescapeString(EscapeString(s)) == s always holds, but the converse isn’t always true.


Argument	Type	Default value	Description
`uri`	`String`		Uri to escape.

Returns String Escaped string.

UPPER

Source

UPPER converts strings to their upper-case counterparts. All other characters are returned unchanged.


Argument	Type	Default value	Description
`str`	`String`		The source string.

Returns String This string in upper case.