String functions
String functions let you modify and transform string data, also known as text. Use a string function to, for example, change capitalization, remove diacritics and accent marks, combine, split, encode, or decode text. Below is a list of supported string functions and a description of each.
ascii (text; [remove diacritics])
Removes all non-ascii characters from a text string.
base64 (text)
Transforms text to base64.
Combine the toBinary() and toString() functions to transform base64 encoded text to plain text, as seen below:
capitalize (text)
Converts the first character in a text string to uppercase.
contains (text; search string)
Verifies if text contains the search string.
decodeURL (text)
Decodes special characters in URL to text.
encodeURL (text)
Encodes special characters in a text to a valid URL address.
escapeHTML (text)
Escapes all HTML tags in text.
indexOf (string; value; [start])
Returns the position of the first occurrence of a specified value in a string. This method returns '-1' if the value searched for never occurs.
length (text or buffer)
Returns the length of text string (number of characters) or binary buffer (buffer size in bytes).
lower (text)
Converts all alphabetical characters in a text string to lowercase.
md5 (text)
Calculates the md5 hash of a string.
Replaces the search string with the new string.
Regular expressions (enclosed in /.../) can be used as search string with a combination of flags (like g, i, m) appended:
The replacement string can include the following special replacement patterns:
- $&= Inserts the matched substring
- $n = Where n is a positive integer less than 100, inserts the nth parenthesized submatch string. Note that this is 1-indexed
Do not use named capture groups like / is (?<number>\d+)/ in the replacement string argument as this will throw an error.
replaceEmojiCharacters (text)
Replaces emoji characters with the new string.
sha1 (text; [encoding]; [key])
Calculates the sha1 hash of a string. If the key argument is specified, sha1 HMAC hash is returned instead. Supported encodings: hex (default), base64 or latin1.
sha256 (text; [encoding]; [key]; [key encoding])
Calculates the sha256 hash of a string. If the key argument is specified, sha256 HMAC hash is returned instead. Supported encodings: hex (default), base64 or latin1.
sha512 (text; [output encoding]; [key]; [key encoding])
Calculates the sha512 hash of a string. If the key argument is specified, sha512 HMAC hash is returned instead. Supported encodings: hex (default), base64 or latin1. Supported key encodings: text (default), hex, base64 or binary. When using binary key encoding, a key must be a buffer, not a string.
split (text; separator)
Splits a string into an array of strings by separating the string into substrings.
startcase (text)
Capitalizes the first letter of every word and lower cases all other letters.
Removes all HTML tags from text.
substring (text; start; end)
Returns a portion of a text string between the "start" position and "the end" position.
Converts any value to binary data. You can also specify encoding as a second argument to apply binary conversions from hex or base64 to binary data.
Converts any value to a string.
trim (text)
Removes space characters at the start or end of the text.
upper (text)
Converts all alphabetical characters in a text string to uppercase.