String Functions

at

str.at(index?: integer = 0): string

Returns the character at the given index.

• When the index is out of bounds, it will return nil type, which will be converted to an empty string when rendered in the template
• When the index is negative, it will count from the end of the string. For example, -1 will return the last character of the string

Arguments:

1. index (integer) - The index of the character to return. Default is 0, which returns the first character of the string

Input Example:

{{ "Textwire".at(1) }}

Output:

e

capitalize

str.capitalize(): string

Capitalizes the first letter of a string

Input Example:

{{ "hello, world!".capitalize() }}

Output:

Hello, world!

contains

str.contains(substr: string): boolean

Returns true if the string contains the given substring, otherwise false. The function is case-sensitive, so the substring must match the case of the string

Arguments:

1. substr (string) - The substring to search for

Input Example:

{{ "Hello, World!".contains("World") }}

Output:

true

Empty Substring

If the substr argument is an empty string, the function will always return true. It's done this way because an empty string is always a substring of any string

Ignore Case

If you want to search for a substring without considering the case, you can use the lower function to convert both the string and the substring to lowercase:

{{ "Hello, World!".lower().contains("world") }} {{-- true --}}

decimal

str.decimal(separator?: string = ".", decimals?: integer = 2): string

Converts to a string with a decimal part by appending a decimal separator and the number of decimal places. Here are some rules:

• When the string is not a number, it will return the string as is
• When the string is already a decimal number, it will return the string as is
• When you use it on a string, it will return the string as is if it's not a number

Arguments:

1. separator (str) (optional) - The separator to use for the decimal. Default is "."
2. decimals (int) (optional) - The number of decimal places to add to the number. Default is 2

Input Example:

{{ "123".decimal() }}

Output:

123.00

first

str.first(): string

Returns the first character of a string. When the string is empty, it will return nil type, which will be converted to an empty string when rendered in the template

Input Example:

{{ "Textwire".first() }}

Output:

T

format

str.format(arg: any...): string

Function format is used to format a string using placeholders. The placeholders are represented by %s in the string, and they will be replaced by the corresponding arguments passed to the function. The number of placeholders in the string should match the number of arguments passed to the function.

Arguments:

1. arg (any) - Any amount of arguments

Input Example:

{{ "I have %s apples, they are %s".format(3, "tasty") }}

Output:

I have 3 apples, they are tasty

Important Notes

• Too many arguments. If you pass more arguments that the string needs, the rest will be ignored.
• Non enough arguments. If you pass not enough arguments, the rest of the placeholders will be rendered as %s.
• Required argument. Requires at least 1 argument.
• Convertion to string. All the arguments passed to the function will be converted to string.

last

str.last(): string

Returns the last character of a string. When the string is empty, it will return nil type, which will be converted to an empty string when rendered in the template

Input Example:

{{ "Textwire".last() }}

Output:

e

len

str.len(): integer

Returns the length of the string

Input Example:

{{ "Hello, World!".len() }}

Output:

13

lower

str.lower(): string

Converts a string to lowercase

Input Example:

{{ "Hello, World!".lower() }}

Output:

hello, world!

raw

str.raw(): string

Function raw is used to render a string as raw HTML. This is useful when you want to render HTML tags from a string. By default, HTML tags in a string are escaped to prevent XSS attacks

Input Example:

{{ "<h1>Test</h1>".raw() }}

Output:

<h1>Test</h1>

repeat

str.repeat(times: integer): string

Returns a new string consisting of count copies of the string on which it was called

Arguments:

1. times (integer) - The number of times to repeat the string

Input Example:

{{ "Hello".repeat(3) }}

Output:

HelloHelloHello

reverse

str.reverse(): string

Returns a string with the characters reversed

Input Example:

{{ "stressed".reverse() }}

Output:

desserts

split

str.split(separator?: string = " "): array

Function split is used to split a string into an array of substrings. It takes an optional argument separator which is used to split the string. If no separator is provided, it defaults to a space

Arguments:

1. separator (string) (optional) - What separator to use to split the string. Default is " " (space)

Input Example:

<div>{{ "one two".split(" ") }}</div>

Output:

<div>one, two</div>

trim

str.trim(chars?: string = "\t \n\r"): string

Trims a string from spaces and special characters like tabs, spaces and new lines by default. You can pass an argument to trim a specific set of characters from a string

Arguments:

1. chars (string) (optional) - A string of characters to trim from a string. Default is "\t \n\r"

Input Example:

<span>{{ " Textwire ".trim() }}</span>

Output:

<span>Textwire</span>

trimLeft

str.trimLeft(chars?: string = "\t \n\r"): string

Trims left side of a string from spaces and special characters like tabs, spaces and new lines by default. You can pass an argument to trim a specific set of characters from a string

Arguments:

1. chars (string) (optional) - A string of characters to trim from a string. Default is "\t \n\r"

Input Example:

<span>{{ " Textwire".trimLeft() }}</span>

Output:

<span>Textwire</span>

trimRight

str.trimRight(chars?: string = "\t \n\r"): string

Trims right side of a string from spaces and special characters like tabs, spaces and new lines by default. You can pass an argument to trim a specific set of characters from a string

Arguments:

1. chars (string) (optional) - A string of characters to trim from a string. Default is "\t \n\r"

Input Example:

<span>{{ "Textwire ".trimRight() }}</span>

Output:

<span>Textwire</span>

truncate

str.truncate(length: integer, ellipsis: string = "..."): string

Returns a string truncated to the given length with an optional ellipsis at the end

Arguments:

1. length (integer) - The length to truncate the string to
2. ellipsis (string) (optional) - The ellipsis to append to the truncated string. Default is "..."

Input Example:

{{ "Hello, World!".truncate(5) }}

Output:

Hello...

upper

str.upper(): string

Converts a string to uppercase

Input Example:

{{ "Hello, World!".upper() }}

Output:

HELLO, WORLD!