Text functions

Reference documentation for Expressif functions in the text scope.

Name	Overview
after-substring	Returns the substring of the argument string, containing all the characters immediately following the first occurrence of the string passed in parameter. If the parameter value is null or empty then the argument value is returned.
allcaps-case	Returns the input text in ALLCAPS case, uppercasing words and concatenating them without separators. Preserves null, empty, and blank inputs; returns null for a zero-length array.
append	Deprecated. Returns the argument value followed by the parameter value. If the argument is null, it returns the text specified as the parameter.
append-new-line	Deprecated. Returns the argument value followed by a space character. If the argument is null, it returns the text specified as the parameter.
append-space	Deprecated. Returns the argument value followed by a space character. If the argument is null, it returns the text specified as the parameter.
before-substring	Returns the substring of the argument string, containing all the characters immediately preceding the first occurrence of the string passed in parameter. If the parameter value is null or empty then the function returns empty.
camel-case	Returns the input text in camelCase, lowercasing the first word and capitalizing subsequent words without separators. Preserves null, empty, and blank inputs; returns null for a zero-length array.
camel-snake-case	Returns the input text in camel_Snake case, lowercasing the first word, capitalizing subsequent words, and joining them with underscores. Preserves null, empty, and blank inputs; returns null for a zero-length array.
capitalize	Returns the input text with its first word capitalized and the remaining content preserved. Words containing dots, ampersands, or uppercase letters beyond the first character are treated as already correctly cased and preserved as-is (for example example.com, AT&T, and iTunes). Returns null when the input is null, DBNull, (null), or a zero-length array.
chars	Returns the characters in the input text as an array in source order. Returns null for null and an empty array for empty text.
clean-whitespace	returns the argument with any whitespace replaced by a space character. \r\n is considered as a single character.
cobol-case	Returns the input text in COBOL-CASE, uppercasing words and joining them with hyphens. Preserves null, empty, and blank inputs; returns null for a zero-length array.
code-point	Returns the Unicode code point represented by a single Unicode scalar value. Returns null for any other input.
collapse-whitespace	returns the argument with any two or more consecutive whitespaces replaced by the first whitespace in the sequence and trimming the result. \r\n is considered as a single character.
count-distinct-chars	Returns the count of distinct chars in the textual argument value. If the value is null or empty then it returns 0. If the value is blank then it returns -1.
count-substring	Returns the count of non-overlapping occurrences of a substring, defined as a parameter, in the argument value.
dot-case	Returns the input text in dot.case, lowercasing words and joining them with periods. Preserves null, empty, and blank inputs; returns null for a zero-length array.
empty-to-null	Returns the argument value except if this value is empty then it returns null.
extract-matches	Returns complete non-overlapping regular expression matches in source order, including zero-length matches. Returns an empty array for null or empty input or when no match is found.
filter-chars	Returns only those characters specified in the parameter, in the order, they were originally entered in the input value.
first-chars	Returns the first chars of the argument value. The length of the string returned is maximum the parameter value, if the argument string is smaller then the full string is returned.
flat-case	Returns the input text in flatcase, lowercasing words and concatenating them without separators. Preserves null, empty, and blank inputs; returns null for a zero-length array.
from-code-point	Returns the text corresponding to an integer Unicode scalar value. Returns null for any other input.
html-to-text	Returns the argument value that has previously been HTML-encoded into a decoded string.
json-escaped-to-text	Returns text by decoding escaped JSON string contents without requiring surrounding quotation marks. Returns null for malformed input and preserves null, empty, and blank inputs.
kebab-case	Returns the input text in kebab-case, lowercasing words and joining them with hyphens. Preserves null, empty, and blank inputs; returns null for a zero-length array.
last-chars	Returns the last chars of the argument value. The length of the string returned is maximum the parameter value, if the argument string is smaller then the full string is returned.
length	Returns the length of the argument value. If the value is null or empty then it returns 0. If the value is blank then it returns -1.
lower	Returns the input text converted to lowercase using invariant culture rules. Returns null when the input is null, DBNull, (null), or a zero-length array.
mask-to-text	Returns the value that passed to the function TextToMask will return the argument value. If the length of the mask and the length of the argument value are not equal the function returns null. If the non-asterisk characters are not matching between the mask and the argument value then the function also returns null.
namespace-case	Returns the input text in namespace::case, lowercasing words and joining them with double colons. Preserves null, empty, and blank inputs; returns null for a zero-length array.
null-to-empty	Returns the argument value except if this value is null then it returns empty.
pad-center	Returns a new string that center-aligns the characters in this string by padding them on both the left and the right with a specified character, for a specified total length. If the padding cannot be symetrical then the padding char is added on the right. If the length of the argument value is longer than the parameter value then the argument value is returned unmodified.
pad-left	Returns a new string that right-aligns the characters in this string by padding them on the left with a specified character, for a specified total length. If the length of the argument value is longer than the parameter value then the argument value is returned unmodified.
pad-right	Returns a new string that left-aligns the characters in this string by padding them on the right with a specified character, for a specified total length. If the length of the argument value is longer than the parameter value then the argument value is returned unmodified.
parse-json	Parses JSON text into native records, arrays, and scalar values.
pascal-case	Returns the input text in PascalCase, capitalizing each word and removing separators. Preserves null, empty, and blank inputs; returns null for a zero-length array.
pascal-snake-case	Returns the input text in Pascal_Snake case, capitalizing each word and joining them with underscores. Preserves null, empty, and blank inputs; returns null for a zero-length array.
path-case	Returns the input text in path/case, lowercasing words and joining them with slashes. Preserves null, empty, and blank inputs; returns null for a zero-length array.
prefix	Returns the argument value preceeded by the parameter value. If the argument is null, it returns null.
prefix-new-line	Returns the argument value preceeded by a space character. If the argument is null, it returns null.
prefix-new-line-if-missing	Prefixes the argument with a CRLF sequence unless it already starts with CRLF. Preserves null.
prefix-space	Returns the argument value preceeded by a space character. If the argument is null, it returns null.
prefix-space-if-missing	Prefixes the argument with a space character unless it already starts with one. Preserves null.
prepend	Deprecated. Returns the argument value preceeded by the parameter value. If the argument is null, it returns the text specified as the parameter.
prepend-new-line	Deprecated. Returns the argument value preceeded by a space character. If the argument is null, it returns the text specified as the parameter.
prepend-space	Deprecated. Returns the argument value preceeded by a space character. If the argument is null, it returns the text specified as the parameter.
remove-chars	Returns the argument value without the specified character. If the argument and the parameter values are white-space characters then it returns empty.
replace-chars	Returns the argument value where a specific char has been replaced by another, both specified as parameters.
replace-slice	Returns the argument value with a subset of the string substitued by a another string.
retain-alpha	Returns the input string with all characters removed except for letters (A-Z, a-z). If the argument is null, it returns null.
retain-alpha-numeric	Returns the input string with all characters removed except for letters (A-Z, a-z) and digits (0-9). If the argument is null, it returns null.
retain-numeric	Returns the input string with all non-numeric characters removed, leaving only digits (0-9).. If the argument is null, it returns null.
retain-numeric-symbol	Returns the input string with all characters removed except for digits (0-9) and the symbols +, -, , and . If the argument is null, it returns null.
screaming-snake-case	Returns the input text in SCREAMING_SNAKE_CASE, uppercasing words and joining them with underscores. Preserves null, empty, and blank inputs; returns null for a zero-length array.
sentence-case	Returns the input text in sentence case by capitalizing the first ordinary word and lowercasing subsequent ordinary words. Words containing dots, ampersands, or uppercase letters beyond the first character are treated as already correctly cased and preserved as-is (for example example.com, AT&T, and iTunes). Returns null when the input is null, DBNull, (null), or a zero-length array.
skip-first-chars	Returns the last chars of the argument value. The length of the string omitted at the beginning of the argument value is equal to the parameter value. If the length of the argument value is smaller or equal to the parameter value then the functions returns empty.
skip-last-chars	Returns the first chars of the argument value. The length of the string omitted at the end of the argument value is equal to the parameter value. If the length of the argument value is smaller or equal to the parameter value then the functions returns empty.
slug	Returns a lowercase, separator-normalized slug, removing Latin diacritics without transliterating non-Latin scripts. Returns empty text when the input is null, empty, or blank.
snake-case	Returns the input text in snake_case, lowercasing words and joining them with underscores. Preserves null, empty, and blank inputs; returns null for a zero-length array.
split-lengths	Splits text into consecutive nonempty segments of the requested lengths, preserving any remaining text as a final segment. Returns an empty array for null or empty input and null for invalid lengths.
split-while	Splits text into consecutive nonempty segments while an operation over the current segment and next character returns true. Preserves every character. Returns an empty array for null or empty input and null for a non-Boolean operation result.
suffix	Returns the argument value followed by the parameter value. If the argument is null, it returns null.
suffix-new-line	Returns the argument value followed by a space character. If the argument is null, it returns null.
suffix-new-line-if-missing	Suffixes the argument with a CRLF sequence unless it already ends with CRLF. Preserves null.
suffix-space	Returns the argument value followed by a space character. If the argument is null, it returns null.
suffix-space-if-missing	Suffixes the argument with a space character unless it already ends with one. Preserves null.
swap-case	Returns the input text with lowercase characters converted to uppercase and uppercase characters converted to lowercase. Returns null when the input is null, DBNull, (null), or a zero-length array.
text	Constructs text by evaluating zero or more positional expressions from left to right against the same input, converting each result to text, and concatenating the converted values in order. Spread arguments expand array values in place. Returns empty text when no expressions are supplied.
text-to-datetime	Returns a dateTime value matching the argument value parsed by the long format in the culture specified in parameter.
text-to-html	Returns the argument value converted to an HTML-encoded string
text-to-json-escaped	Returns the escaped contents of a JSON string without surrounding quotation marks. Preserves null, empty, and blank inputs.
text-to-mask	Returns the argument value formatted according to the mask specified as parameter. Each asterisk (*) of the mask is replaced by the corresponding character in the argument value. Other charachters of the mask are not substitued. If the length of the argument value is less than the count of charachetsr that must be replaced in the mask, the last asterisk characters are not replaced.
text-to-uri	Returns the input text escaped as URI data using UTF-8 percent encoding. Preserves null, empty, and blank inputs.
text-to-xml-escaped	Returns text escaped for use as XML character data without adding a containing element. Returns null for characters that are invalid in XML and preserves null, empty, and blank inputs.
title-case	Returns the input text in title case, capitalizing words while keeping small words lowercase only when they are neither first nor last and do not follow a colon. The first and last words are always capitalized, and a small word after a colon is capitalized. Words containing dots, ampersands, or uppercase letters beyond the first character are treated as already correctly cased and preserved as-is (for example example.com, Q&A, and iTunes). Returns null when the input is null, DBNull, (null), or a zero-length array.
token	Returns the token at the specified index in the argument value. The index of the first token is 0, the second token is 1, and so on. By default, the tokenization is executed based on any white-space characters. If a character is specified then the tokenization is executed based on this character to separate two tokens.
token-count	Returns the count of token within the argument value. By default, the tokenization is executed based on any white-space characters. If a character is specified then the tokenization is executed based on this character to separate two tokens.
token-count-lexical	Returns the number of lexical tokens in the argument value, including punctuation and symbols.
tokenize	Returns all tokens in the argument value in source order. By default, tokenization uses white-space characters as delimiters. If a character is specified, that character delimits the tokens.
tokenize-camel	Returns tokens from a camelCase name using case and acronym transitions as boundaries.
tokenize-kebab	Returns normalized tokens from a hyphen-separated name, preserving escaped hyphens within tokens.
tokenize-lexical	Returns lexical tokens in source order, preserving punctuation and symbols as separate tokens.
tokenize-lines	Returns lines in source order, recognizing CR, LF, and CRLF as separators. Preserves spaces and empty lines, including a final empty line after a trailing separator. Returns an empty array for null or empty input.
tokenize-pascal	Returns tokens from a PascalCase name using case and acronym transitions as boundaries.
tokenize-regex	Returns segments separated by regular expression matches in source order. Preserves spaces and empty segments without including captured delimiters. Returns an empty array for null or empty input.
tokenize-snake	Returns normalized tokens from an underscore-separated name, preserving escaped underscores within tokens.
tokenize-words	Returns word tokens using separators, punctuation, symbols, case transitions, and acronym transitions as boundaries.
train-case	Returns the input text in Train-Case, capitalizing each word and joining them with hyphens. Preserves null, empty, and blank inputs; returns null for a zero-length array.
trim	Returns the argument value without all leading or trailing white-space characters.
upper	Returns the input text converted to uppercase using invariant culture rules. Returns null when the input is null, DBNull, (null), or a zero-length array.
uri-to-text	Returns text by unescaping one layer of URI percent encoding. Preserves null, empty, and blank inputs.
whitespaces-to-empty	Returns the argument value except if this value only contains white-space characters then it returns empty.
whitespaces-to-null	Returns the argument value except if this value only contains white-space characters then it returns null.
without-diacritics	Returns the argument string without diacritics.
without-whitespaces	Returns the argument string without white-space characters.
xml-escaped-to-text	Returns text by decoding XML character data without requiring a containing element. Returns null for malformed input and preserves null, empty, and blank inputs.