This document describes the various built-in functions available in scriban.

• array functions
• date functions
• html functions
• math functions
• object functions
• regex functions
• string functions
• timespan functions

🔝

Array functions available through the object 'array' in scriban.

• array.add
• array.add_range
• array.compact
• array.concat
• array.cycle
• array.each
• array.filter
• array.first
• array.insert_at
• array.join
• array.last
• array.limit
• array.map
• array.offset
• array.remove_at
• array.reverse
• array.size
• array.sort
• array.uniq
• array.contains

🔝

array.add <list> <value>

Adds a value to the input list.

• list: The input list
• value: The value to add at the end of the list

A new list with the value added

input

{{ [1, 2, 3] | array.add 4 }}

output

[1, 2, 3, 4]

🔝

array.add_range <list1> <list2>

Concatenates two lists.

• list1: The 1st input list
• list2: The 2nd input list

The concatenation of the two input lists

input

{{ [1, 2, 3] | array.add_range [4, 5] }}

output

[1, 2, 3, 4, 5]

🔝

array.compact <list>

Removes any null values from the input list.

• list: An input list

Returns a list with null value removed

input

{{ [1, null, 3] | array.compact }}

output

[1, 3]

🔝

array.concat <list1> <list2>

Concatenates two lists.

• list1: The 1st input list
• list2: The 2nd input list

The concatenation of the two input lists

input

{{ [1, 2, 3] | array.concat [4, 5] }}

output

[1, 2, 3, 4, 5]

🔝

array.cycle <list> <group>?

Loops through a group of strings and outputs them in the order that they were passed as parameters. Each time cycle is called, the next string that was passed as a parameter is output.

• list: An input list
• group: The group used. Default is null

Returns a list with null value removed

input

{{ array.cycle ['one', 'two', 'three'] }}
{{ array.cycle ['one', 'two', 'three'] }}
{{ array.cycle ['one', 'two', 'three'] }}
{{ array.cycle ['one', 'two', 'three'] }}

output

one
two
three
one

cycle accepts a parameter called cycle group in cases where you need multiple cycle blocks in one template. If no name is supplied for the cycle group, then it is assumed that multiple calls with the same parameters are one group.

🔝

array.each <list> <function>

Applies the specified function to each element of the input.

• list: An input list
• function: The function to apply to each item in the list

Returns a list with each item being transformed by the function.

input

{{ [" a", " 5", "6 "] | array.each @string.strip }}

output

["a", "5", "6"]

🔝

array.filter <list> <function>

Filters the input list according the supplied filter function.

• list: An input list
• function: The function used to test each elemement of the list

Returns a new list which contains only those elements which match the filter function.

input

{{["", "200", "","400"] | array.filter @string.empty}}

output

["", ""]

🔝

array.first <list>

Returns the first element of the input list.

• list: The input list

The first element of the input list.

input

{{ [4, 5, 6] | array.first }}

output

4

🔝

array.insert_at <list> <index> <value>

Inserts a value at the specified index in the input list.

• list: The input list
• index: The index in the list where to insert the element
• value: The value to insert

A new list with the element inserted.

input

{{ ["a", "b", "c"] | array.insert_at 2 "Yo" }}

output

["a", "b", "Yo", "c"]

🔝

array.join <list> <delimiter> <function>?

Joins the element of a list separated by a delimiter string and return the concatenated string.

• list: The input list
• delimiter: The delimiter string to use to separate elements in the output string
• function: An optional function that will receive the string representation of the item to join and can transform the text before joining.

A new list with the element inserted.

input

{{ [1, 2, 3] | array.join "|" }}

output

1|2|3

🔝

array.last <list>

Returns the last element of the input list.

• list: The input list

The last element of the input list.

input

{{ [4, 5, 6] | array.last }}

output

6

🔝

array.limit <list> <count>

Returns a limited number of elments from the input list

• list: The input list
• count: The number of elements to return from the input list

input

{{ [4, 5, 6] | array.limit 2 }}

output

[4, 5]

🔝

array.map <list> <member>

Accepts an array element's attribute as a parameter and creates an array out of each array element's value.

• list: The input list
• member: The member to extract the value from

input

{{
products = [{title: "orange", type: "fruit"}, {title: "computer", type: "electronics"}, {title: "sofa", type: "furniture"}]
products | array.map "type" | array.uniq | array.sort }}

output

["electronics", "fruit", "furniture"]

🔝

array.offset <list> <index>

Returns the remaining of the list after the specified offset

• list: The input list
• index: The index of a list to return elements

input

{{ [4, 5, 6, 7, 8] | array.offset 2 }}

output

[6, 7, 8]

🔝

array.remove_at <list> <index>

Removes an element at the specified index from the input list

• list: The input list
• index: The index of a list to return elements

A new list with the element removed. If index is negative, remove at the end of the list.

input

{{ [4, 5, 6, 7, 8] | array.remove_at 2 }}

output

[4, 5, 7, 8]

If the index is negative, removes at the end of the list (notice that we need to put -1 in parenthesis to avoid confusing the parser with a binary - operation):

input

{{ [4, 5, 6, 7, 8] | array.remove_at (-1) }}

output

[4, 5, 6, 7]

🔝

array.reverse <list>

Reverses the input list

• list: The input list

A new list in reversed order.

input

{{ [4, 5, 6, 7] | array.reverse }}

output

[7, 6, 5, 4]

🔝

array.size <list>

Returns the number of elements in the input list

• list: The input list

A number of elements in the input list.

input

{{ [4, 5, 6] | array.size }}

output

3

🔝

array.sort <list> <member>?

Sorts the elements of the input list according to the value of each element or the value of the specified member of each element

• list: The input list
• member: The member name to sort according to its value. Null by default, meaning that the element's value are used instead.

A list sorted according to the value of each element or the value of the specified member of each element.

Sorts by element's value:

input

{{ [10, 2, 6] | array.sort }}

output

[2, 6, 10]

Sorts by elements member's value:

input

{{
products = [{title: "orange", type: "fruit"}, {title: "computer", type: "electronics"}, {title: "sofa", type: "furniture"}]
products | array.sort "title" | array.map "title"
}}

output

["computer", "orange", "sofa"]

🔝

array.uniq <list>

Returns the unique elements of the input list.

• list: The input list

A list of unique elements of the input list.

input

{{ [1, 1, 4, 5, 8, 8] | array.uniq }}

output

[1, 4, 5, 8]

🔝

array.contains <list> <item>

Returns if a list contains a specific item.

• list: The input list
• item: The input item

true if item is in list; otherwise false

input

{{ [1, 2, 3, 4] | array.contains 4 }}

output

true

🔝

A datetime object represents an instant in time, expressed as a date and time of day.

🔝

The subtract operation date1 - date2: Subtract date2 from date1 and return a timespan internal object (see timespan object below).

Other comparison operators(==, !=, <=, >=, <, >) are also working with date objects.

A timespan and also the added to a datetime object.

• date.now
• date.add_days
• date.add_months
• date.add_years
• date.add_hours
• date.add_minutes
• date.add_seconds
• date.add_milliseconds
• date.parse
• date.to_string

🔝

date.now

Returns a datetime object of the current time, including the hour, minutes, seconds and milliseconds.

input

{{ date.now.year }}

output

2024

🔝

date.add_days <date> <days>

Adds the specified number of days to the input date.

• date: The date.
• days: The days.

A new date

input

{{ date.parse '2016/01/05' | date.add_days 1 }}

output

06 Jan 2016

🔝

date.add_months <date> <months>

Adds the specified number of months to the input date.

• date: The date.
• months: The months.

A new date

input

{{ date.parse '2016/01/05' | date.add_months 1 }}

output

05 Feb 2016

🔝

date.add_years <date> <years>

Adds the specified number of years to the input date.

• date: The date.
• years: The years.

A new date

input

{{ date.parse '2016/01/05' | date.add_years 1 }}

output

05 Jan 2017

🔝

date.add_hours <date> <hours>

Adds the specified number of hours to the input date.

• date: The date.
• hours: The hours.

A new date

🔝

date.add_minutes <date> <minutes>

Adds the specified number of minutes to the input date.

• date: The date.
• minutes: The minutes.

A new date

🔝

date.add_seconds <date> <seconds>

Adds the specified number of seconds to the input date.

• date: The date.
• seconds: The seconds.

A new date

🔝

date.add_milliseconds <date> <millis>

Adds the specified number of milliseconds to the input date.

• date: The date.
• millis: The milliseconds.

A new date

🔝

date.parse <text> <pattern>? <culture>?

Parses the specified input string to a date object.

• text: A text representing a date.
• pattern: The date format pattern. See to_string method about the format of a pattern.
• culture: The culture used to format the datetime. Default is current culture.

A date object

input

{{ date.parse '2016/01/05' }}
{{ date.parse '2018--06--17' '%Y--%m--%d' }}
{{ date.parse '2021/11/30 20:50:23Z' }}
{{ date.parse '20/01/2022 08:32:48 +00:00' culture:'en-GB' }}

output

05 Jan 2016
17 Jun 2018
30 Nov 2021
20 Jan 2022

🔝

date.to_string <datetime> <pattern> <culture>

Converts a datetime object to a textual representation using the specified format string.

By default, if you are using a date, it will use the format specified by date.format which defaults to date.default_format (readonly) which default to %d %b %Y

You can override the format used for formatting all dates by assigning the a new format: date.format = '%a %b %e %T %Y';

You can recover the default format by using date.format = date.default_format;

By default, the to_string format is using the current culture, but you can switch to an invariant culture by using the modifier %g

For example, using %g %d %b %Y will output the date using an invariant culture.

If you are using %g alone, it will output the date with date.format using an invariant culture.

Suppose that date.now would return the date 2013-09-12 22:49:27 +0530, the following table explains the format modifiers:

Note that the format is using a good part of the ruby format (source)

input

{{ date.parse '2016/01/05' | date.to_string '%d %b %Y' }}
{{ date.parse '2016/01/05' | date.to_string '%d %B %Y' 'fr-FR' }}

output

05 Jan 2016
05 janvier 2016

• datetime: The input datetime to format
• pattern: The date format pattern.
• culture: The culture used to format the datetime

A that represents this instance.

🔝

Html functions available through the builtin object 'html'.

• html.strip
• html.escape
• html.url_encode
• html.url_escape

🔝

html.strip <text>

Removes any HTML tags from the input string

• text: The input string

The input string removed with any HTML tags

Notice that the implementation of this function is using a simple regex, so it can fail escaping correctly or timeout in case of the malformed html. If you are looking for a secure HTML stripped, you might want to plug your own HTML function by using AngleSharp to strip these HTML tags.

input

{{ "<p>This is a paragraph</p>" | html.strip }}

output

This is a paragraph

🔝

html.escape <text>

Escapes a HTML input string (replacing & by &)

• text: The input string

The input string removed with any HTML tags

input

{{ "<p>This is a paragraph</p>" | html.escape }}

output

<p>This is a paragraph</p>

🔝

html.url_encode <text>

Converts any URL-unsafe characters in a string into percent-encoded characters.

• text: The input string

The input string url encoded

input

{{ "[email protected]" | html.url_encode }}

output

john%40liquid.com

🔝

html.url_escape <text>

Identifies all characters in a string that are not allowed in URLS, and replaces the characters with their escaped variants.

• text: The input string

The input string url escaped

input

{{ "<hello> & <scriban>" | html.url_escape }}

output

%3Chello%3E%20&%20%3Cscriban%3E

🔝

Math functions available through the object 'math' in scriban.

• math.abs
• math.ceil
• math.divided_by
• math.floor
• math.format
• math.is_number
• math.minus
• math.modulo
• math.plus
• math.round
• math.times
• math.uuid
• math.random

🔝

math.abs <value>

Returns the absolute value of a specified number.

• value: The input value

The absolute value of the input value

input

{{ -15.5| math.abs }}
{{ -5| math.abs }}

output

15.5
5

🔝

math.ceil <value>

Returns the smallest integer greater than or equal to the specified number.

• value: The input value

The smallest integer greater than or equal to the specified number.

input

{{ 4.6 | math.ceil }}
{{ 4.3 | math.ceil }}

output

5
5

🔝

math.divided_by <value> <divisor>

Divides the specified value by another value. If the divisor is an integer, the result will be floor to and converted back to an integer.

• value: The input value
• divisor: The divisor value

The division of value by divisor.

input

{{ 8.4 | math.divided_by 2.0 | math.round 1 }}
{{ 8.4 | math.divided_by 2 }}

output

4.2
4

🔝

math.floor <value>

Returns the largest integer less than or equal to the specified number.

• value: The input value

The largest integer less than or equal to the specified number.

input

{{ 4.6 | math.floor }}
{{ 4.3 | math.floor }}

output

4
4

🔝

math.format <value> <format> <culture>?

Formats a number value with specified .NET standard numeric format strings

• value: The input value
• format: The format string.
• culture: The culture as a string (e.g en-US). By default the culture from is used

The largest integer less than or equal to the specified number.

input

{{ 255 | math.format "X4" }}

output

00FF

🔝

math.is_number <value>

Returns a boolean indicating if the input value is a number

• value: The input value

true if the input value is a number; otherwise false.

input

{{ 255 | math.is_number }}
{{ "yo" | math.is_number }}

output

true
false

🔝

math.minus <value> <with>

Subtracts from the input value the with value

• value: The input value
• with: The with value to subtract from value

The results of the subtraction: value - with

input

{{ 255 | math.minus 5}}

output

250

🔝

math.modulo <value> <with>

Performs the modulo of the input value with the with value

• value: The input value
• with: The with value to module value

The results of the modulo: value % with

input

{{ 11 | math.modulo 10}}

output

1

🔝

math.plus <value> <with>

Performs the addition of the input value with the with value

• value: The input value
• with: The with value to add tovalue

The results of the addition: value + with

input

{{ 1 | math.plus 2}}

output

3

🔝

math.round <value> <precision: 0>?

Rounds a value to the nearest integer or to the specified number of fractional digits.

• value: The input value
• precision: The number of fractional digits in the return value. Default is 0.

A value rounded to the nearest integer or to the specified number of fractional digits.

input

{{ 4.6 | math.round }}
{{ 4.3 | math.round }}
{{ 4.5612 | math.round 2 }}

output

5
4
4.56

🔝

math.times <value> <with>

Performs the multiplication of the input value with the with value

• value: The input value
• with: The with value to multiply tovalue

The results of the multiplication: value * with

input

{{ 2 | math.times 3}}

output

6

🔝

math.uuid

Creates a new UUID

The created UUID, ex. 2dc55d50-3f6c-446a-87d0-a5a4eed23269

input

{{ math.uuid }}

output

1c0a4aa8-680e-4bd6-95e9-cdbec45ef057

🔝

math.random <minValue> <maxValue>

Creates a random number

• minValue: The inclusive lower bound of the random number returned
• maxValue: The exclusive upper bound of the random number returned. maxValue must be greater than or equal to minValue.

A random number greater or equal to minValue and less than maxValue

input

{{ math.random 1 10 }}

output

7

🔝

Object functions available through the builtin object 'object'.

• object.default
• object.eval
• object.eval_template
• object.format
• object.has_key
• object.has_value
• object.keys
• object.size
• object.typeof
• object.kind
• object.values
• object.from_json
• object.to_json

🔝

object.default <value> <default>

The default value is returned if the input value is null or an empty string "". A string containing whitespace characters will not resolve to the default value.

• value: The input value to check if it is null or an empty string.
• default: The default value to return if the input value is null or an empty string.

The default value is returned if the input value is null or an empty string "", otherwise it returns value

input

{{ undefined_var | object.default "Yo" }}

output

Yo

🔝

object.eval <value>

The evaluates a string as a scriban expression or evaluate the passed function or return the passed value.

• value: The input value, either a scriban template in a string, or an alias function or directly a value.

The evaluation of the input value.

input

{{ "1 + 2" | object.eval }}

output

3

🔝

object.eval_template <value>

The evaluates a string as a scriban template or evaluate the passed function or return the passed value.

• value: The input value, either a scriban template in a string, or an alias function or directly a value.

The evaluation of the input value.

input

{{ "This is a template text {{ 1 + 2 }}" | object.eval_template }}

output

This is a template text 3

🔝

object.format <value> <format> <culture>?

Formats an object using specified format.

• value: The input value
• format: The format string.
• culture: The culture as a string (e.g en-US). By default the culture from is used

input

{{ 255 | object.format "X4" }}
{{ 1523 | object.format "N2" "en-US" }}

output

00FF
1,523.00

🔝

object.has_key <value> <key>

Checks if the specified object as the member key

• value: The input object.
• key: The member name to check its existence.

true if the input object contains the member key; otherwise false

input

{{ product | object.has_key "title" }}

output

true

🔝

object.has_value <value> <key>

Checks if the specified object as a value for the member key

• value: The input object.
• key: The member name to check the existence of its value.

true if the input object contains the member key and has a value; otherwise false

input

{{ product | object.has_value "title" }}

output

true

🔝

object.keys <value>

Gets the members/keys of the specified value object.

• value: The input object.

A list with the member names/key of the input object

input

{{ product | object.keys | array.sort }}

output

["title", "type"]

🔝

object.size <value>

Returns the size of the input object.

• If the input object is a string, it will return the length
• If the input is a list, it will return the number of elements
• If the input is an object, it will return the number of members

• value: The input object.

The size of the input object.

input

{{ [1, 2, 3] | object.size }}

output

3

🔝

object.typeof <value>

Returns string representing the type of the input object. The type can be string, boolean, number, array, iterator and object

• value: The input object.

input

{{ null | object.typeof }}
{{ true | object.typeof }}
{{ 1 | object.typeof }}
{{ 1.0 | object.typeof }}
{{ "text" | object.typeof }}
{{ 1..5 | object.typeof }}
{{ [1,2,3,4,5] | object.typeof }}
{{ {} | object.typeof }}
{{ object | object.typeof }}

output

boolean
number
number
string
iterator
array
object
object

🔝

object.kind <value>

Returns string representing the type of the input object. The type can be string, bool, byte, sbyte, ushort, short, uint, int, ulong, long, float, double, decimal, bigint, enum, range, array, function and object

• value: The input object.

This function is newer than object.typeof and returns more detailed results about the types (e.g instead of number, returns int or double)

input

{{ null | object.kind }}
{{ true | object.kind }}
{{ 1 | object.kind }}
{{ 1.0 | object.kind }}
{{ "text" | object.kind }}
{{ 1..5 | object.kind }}
{{ [1,2,3,4,5] | object.kind }}
{{ {} | object.kind }}
{{ object | object.kind }}

output

bool
int
double
string
range
array
object
object

🔝

object.values <value>

Gets the member's values of the specified value object.

• value: The input object.

A list with the member values of the input object

input

{{ product | object.values | array.sort }}

output

["fruit", "Orange"]

🔝

object.from_json <value>

Converts a JSON string to a scriban value.

• value: The input JSON string.

The scriban value.

input

{{
    obj = `{ "foo": 123 }` | object.from_json
    obj.foo
}}

output

123

🔝

object.to_json <value>

Converts a scriban value to a JSON string.

• value: The input value.

A JSON representation of the value.

input

{{ { foo: "bar", baz: [1, 2, 3] } | object.to_json }}
{{ true | object.to_json }}
{{ null | object.to_json }}

output

{"foo":"bar","baz":[1,2,3]}
true
null

🔝

Functions exposed through regex builtin object.

Note: If your regular expression contains backslashes (\), you will need to do one of the following:

• Anywhere you would use a \, use two. For example: "\d+\.\d+" becomes "\\d+\\.\\d+"
• Use verbatim strings. For example: "\d+\.\d+" becomes `\d+\.\d+`

• regex.escape
• regex.match
• regex.matches
• regex.replace
• regex.split
• regex.unescape

🔝

regex.escape <pattern>

Escapes a minimal set of characters (\, *, +, ?, |, {, [, (,), ^, $,., #, and white space) by replacing them with their escape codes. This instructs the regular expression engine to interpret these characters literally rather than as metacharacters.

• pattern: The input string that contains the text to convert.

A string of characters with metacharacters converted to their escaped form.

input

{{ "(abc.*)" | regex.escape }}

output

\(abc\.\*\)

🔝

regex.match <text> <pattern> <options>?

Searches an input string for a substring that matches a regular expression pattern and returns an array with the match occurences.

• text: The string to search for a match.
• pattern: The regular expression pattern to match.
• options: A string with regex options, that can contain the following option characters (default is null): - i: Specifies case-insensitive matching. - m: Multiline mode. Changes the meaning of ^ and $ so they match at the beginning and end, respectively, of any line, and not just the beginning and end of the entire string. - s: Specifies single-line mode. Changes the meaning of the dot . so it matches every character (instead of every character except \n). - x: Eliminates unescaped white space from the pattern and enables comments marked with #.

An array that contains all the match groups. The first group contains the entire match. The other elements contain regex matched groups (..). An empty array returned means no match.

input

{{ "this is a text123" | regex.match `(\w+) a ([a-z]+\d+)` }}

output

["is a text123", "is", "text123"]

Notice that the first element returned in the array is the entire regex match, followed by the regex group matches.

🔝

regex.matches <text> <pattern> <options>?

Searches an input string for multiple substrings that matches a regular expression pattern and returns an array with the match occurences.

• text: The string to search for a match.
• pattern: The regular expression pattern to match.
• options: A string with regex options, that can contain the following option characters (default is null): - i: Specifies case-insensitive matching. - m: Multiline mode. Changes the meaning of ^ and $ so they match at the beginning and end, respectively, of any line, and not just the beginning and end of the entire string. - s: Specifies single-line mode. Changes the meaning of the dot . so it matches every character (instead of every character except \n). - x: Eliminates unescaped white space from the pattern and enables comments marked with #.

An array of matches that contains all the match groups. The first group contains the entire match. The other elements contain regex matched groups (..). An empty array returned means no match.

input

{{ "this is a text123" | regex.matches `(\w+)` }}

output

[["this", "this"], ["is", "is"], ["a", "a"], ["text123", "text123"]]

Notice that the first element returned in the sub array is the entire regex match, followed by the regex group matches.

🔝

regex.replace <text> <pattern> <replace> <options>?

In a specified input string, replaces strings that match a regular expression pattern with a specified replacement string.

• text: The string to search for a match.
• pattern: The regular expression pattern to match.
• replace: The replacement string.
• options: A string with regex options, that can contain the following option characters (default is null): - i: Specifies case-insensitive matching. - m: Multiline mode. Changes the meaning of ^ and $ so they match at the beginning and end, respectively, of any line, and not just the beginning and end of the entire string. - s: Specifies single-line mode. Changes the meaning of the dot . so it matches every character (instead of every character except \n). - x: Eliminates unescaped white space from the pattern and enables comments marked with #.

A new string that is identical to the input string, except that the replacement string takes the place of each matched string. If pattern is not matched in the current instance, the method returns the current instance unchanged.

input

{{ "abbbbcccd" | regex.replace "b+c+" "-Yo-" }}

output

a-Yo-d

🔝

regex.split <text> <pattern> <options>?

Splits an input string into an array of substrings at the positions defined by a regular expression match.

• text: The string to split.
• pattern: The regular expression pattern to match.
• options: A string with regex options, that can contain the following option characters (default is null): - i: Specifies case-insensitive matching. - m: Multiline mode. Changes the meaning of ^ and $ so they match at the beginning and end, respectively, of any line, and not just the beginning and end of the entire string. - s: Specifies single-line mode. Changes the meaning of the dot . so it matches every character (instead of every character except \n). - x: Eliminates unescaped white space from the pattern and enables comments marked with #.

A string array.

input

{{ "a, b   , c,    d" | regex.split `\s*,\s*` }}

output

["a", "b", "c", "d"]

🔝

regex.unescape <pattern>

Converts any escaped characters in the input string.

• pattern: The input string containing the text to convert.

A string of characters with any escaped characters converted to their unescaped form.

input

{{ "\\(abc\\.\\*\\)" | regex.unescape }}

output

(abc.*)

🔝

String functions available through the builtin object 'string`.

• string.escape
• string.append
• string.capitalize
• string.capitalizewords
• string.contains
• string.empty
• string.whitespace
• string.downcase
• string.ends_with
• string.equals_ignore_case
• string.handleize
• string.literal
• string.lstrip
• string.pluralize
• string.prepend
• string.remove
• string.remove_first
• string.remove_last
• string.replace
• string.replace_first
• string.rstrip
• string.size
• string.slice
• string.slice1
• string.split
• string.starts_with
• string.strip
• string.strip_newlines
• string.to_int
• string.to_long
• string.to_float
• string.to_double
• string.truncate
• string.truncatewords
• string.upcase
• string.md5
• string.sha1
• string.sha256
• string.hmac_sha1
• string.hmac_sha256
• string.pad_left
• string.pad_right
• string.base64_encode
• string.base64_decode
• string.index_of

🔝

string.escape <text>

Escapes a string with escape characters.

• text: The input string

The two strings concatenated

input

{{ "Hel\tlo\n\"W\\orld" | string.escape }}

output

Hel\tlo\n\"W\\orld

🔝

string.append <text> <with>

Concatenates two strings

• text: The input string
• with: The text to append

The two strings concatenated

input

{{ "Hello" | string.append " World" }}

output

Hello World

🔝

string.capitalize <text>

Converts the first character of the passed string to a upper case character.

• text: The input string

The capitalized input string

input

{{ "test" | string.capitalize }}

output

Test

🔝

string.capitalizewords <text>

Converts the first character of each word in the passed string to a upper case character.

• text: The input string

The capitalized input string

input

{{ "This is easy" | string.capitalizewords }}

output

This Is Easy

🔝

string.contains <text> <value>

Returns a boolean indicating whether the input string contains the specified string value.

• text: The input string
• value: The string to look for

if text contains the string value

input

{{ "This is easy" | string.contains "easy" }}

output

true

🔝

string.empty <text>

Returns a boolean indicating whether the input string is an empty string.

• text: The input string

if text is an empty string

input

{{ "" | string.empty }}

output

true

🔝

string.whitespace <text>

Returns a boolean indicating whether the input string is empty or contains only whitespace characters.

• text: The input string

if text is empty string or contains only whitespace characters

input

{{ "" | string.whitespace }}

output

true

🔝

string.downcase <text>

Converts the string to lower case.

• text: The input string

The input string lower case

input

{{ "TeSt" | string.downcase }}

output

test

🔝

string.ends_with <text> <value>

Returns a boolean indicating whether the input string ends with the specified string value.

• text: The input string
• value: The string to look for

if text ends with the specified string value

input

{{ "This is easy" | string.ends_with "easy" }}

output

true

🔝

string.equals_ignore_case <text> <value>

Returns a boolean indicating whether the input string is equal to specified string 'value'. Comparison is case insensitive.

• text: The input string
• value: The string to compare

if text is equal to string value, ignoring case

input

{{ "Scriban" | string.equals_ignore_case "SCRIBAN" }}

output

true

🔝

string.handleize <text>

Returns a url handle from the input string.

• text: The input string

A url handle

input

{{ '100% M & Ms!!!' | string.handleize  }}

output

100-m-ms

🔝

string.literal <text>

Return a string literal enclosed with double quotes of the input string.

• text: The string to return a literal from.

The literal of a string.

If the input string has non printable characters or they need contain a double quote, they will be escaped.

input

{{ 'Hello\n"World"' | string.literal }}

output

"Hello\n\"World\""

🔝

string.lstrip <text>

Removes any whitespace characters on the left side of the input string.

• text: The input string

The input string without any left whitespace characters

input

{{ '   too many spaces' | string.lstrip  }}

Highlight to see the empty spaces to the right of the string output

too many spaces

🔝

string.pluralize <number> <singular> <plural>

Outputs the singular or plural version of a string based on the value of a number.

• number: The number to check
• singular: The singular string to return if number is == 1
• plural: The plural string to return if number is != 1

The singular or plural string based on number

input

{{ products.size }} {{products.size | string.pluralize 'product' 'products' }}

output

7 products

🔝

string.prepend <text> <by>

Concatenates two strings by placing the by string in from of the text string

• text: The input string
• by: The string to prepend to text

The two strings concatenated

input

{{ "World" | string.prepend "Hello " }}

output

Hello World

🔝

string.remove <text> <remove>

Removes all occurrences of a substring from a string.

• text: The input string
• remove: The substring to remove from the text string

The input string with the all occurence of a substring removed

input

{{ "Hello, world. Goodbye, world." | string.remove "world" }}

output

Hello, . Goodbye, .

🔝

string.remove_first <text> <remove>

Removes the first occurrence of a substring from a string.

• text: The input string
• remove: The first occurence of substring to remove from the text string

The input string with the first occurence of a substring removed

input

{{ "Hello, world. Goodbye, world." | string.remove_first "world" }}

output

Hello, . Goodbye, world.

🔝

string.remove_last <text> <remove>

Removes the last occurrence of a substring from a string.

• text: The input string
• remove: The last occurence of substring to remove from the text string

The input string with the first occurence of a substring removed

input

{{ "Hello, world. Goodbye, world." | string.remove_last "world" }}

output

Hello, world. Goodbye, .

🔝

string.replace <text> <match> <replace>

Replaces all occurrences of a string with a substring.

• text: The input string
• match: The substring to find in the text string
• replace: The substring used to replace the string matched by match in the input text

The input string replaced

input

{{ "Hello, world. Goodbye, world." | string.replace "world" "buddy" }}

output

Hello, buddy. Goodbye, buddy.

🔝

string.replace_first <text> <match> <replace> <fromEnd: False>?

Replaces the first occurrence of a string with a substring.

• text: The input string
• match: The substring to find in the text string
• replace: The substring used to replace the string matched by match in the input text
• fromEnd: if true start match from end

The input string replaced

input

{{ "Hello, world. Goodbye, world." | string.replace_first "world" "buddy" }}

output

Hello, buddy. Goodbye, world.

🔝

string.rstrip <text>

Removes any whitespace characters on the right side of the input string.

• text: The input string

The input string without any left whitespace characters

input

{{ '   too many spaces           ' | string.rstrip  }}

Highlight to see the empty spaces to the right of the string output

   too many spaces

🔝

string.size <text>

Returns the number of characters from the input string

• text: The input string

The length of the input string

input

{{ "test" | string.size }}

output

4

🔝

string.slice <text> <start> <length>?

The slice returns a substring, starting at the specified index. An optional second parameter can be passed to specify the length of the substring. If no second parameter is given, a substring with the remaining characters will be returned.

• text: The input string
• start: The starting index character where the slice should start from the input text string
• length: The number of character. Default is 0, meaning that the remaining of the string will be returned.

The input string sliced

input

{{ "hello" | string.slice 0 }}
{{ "hello" | string.slice 1 }}
{{ "hello" | string.slice 1 3 }}
{{ "hello" | string.slice 1 length:3 }}

output

hello
ello
ell
ell

🔝

string.slice1 <text> <start> <length: 1>?

The slice returns a substring, starting at the specified index. An optional second parameter can be passed to specify the length of the substring. If no second parameter is given, a substring with the first character will be returned.

• text: The input string
• start: The starting index character where the slice should start from the input text string
• length: The number of character. Default is 1, meaning that only the first character at start position will be returned.

The input string sliced

input

{{ "hello" | string.slice1 0 }}
{{ "hello" | string.slice1 1 }}
{{ "hello" | string.slice1 1 3 }}
{{ "hello" | string.slice1 1 length: 3 }}

output

h
e
ell
ell

🔝

string.split <text> <match>

The split function takes on a substring as a parameter. The substring is used as a delimiter to divide a string into an array. You can output different parts of an array using array functions.

• text: The input string
• match: The string used to split the input text string

An enumeration of the substrings

input

{{ for word in "Hi, how are you today?" | string.split ' ' ~}}
{{ word }}
{{ end ~}}

output

Hi,
how
are
you
today?

🔝

string.starts_with <text> <value>

Returns a boolean indicating whether the input string starts with the specified string value.

• text: The input string
• value: The string to look for

if text starts with the specified string value

input

{{ "This is easy" | string.starts_with "This" }}

output

true

🔝

string.strip <text>

Removes any whitespace characters on the left and right side of the input string.

• text: The input string

The input string without any left and right whitespace characters

input

{{ '   too many spaces           ' | string.strip  }}

Highlight to see the empty spaces to the right of the string output

too many spaces

🔝

string.strip_newlines <text>

Removes any line breaks/newlines from a string.

• text: The input string

The input string without any breaks/newlines characters

input

{{ "This is a string.\r\n With \nanother \rstring" | string.strip_newlines  }}

output

This is a string. With another string

🔝

string.to_int <text>

Converts a string to an integer

• text: The input string

A 32 bit integer or null if conversion failed

input

{{ "123" | string.to_int + 1 }}

output

124

🔝

string.to_long <text>

Converts a string to a long 64 bit integer

• text: The input string

A 64 bit integer or null if conversion failed

input

{{ "123678912345678" | string.to_long + 1 }}

output

123678912345679

🔝

string.to_float <text>

Converts a string to a float

• text: The input string

A 32 bit float or null if conversion failed

input

{{ "123.4" | string.to_float + 1 }}

output

124.4

🔝

string.to_double <text>

Converts a string to a double

• text: The input string

A 64 bit float or null if conversion failed

input

{{ "123.4" | string.to_double + 1 }}

output

124.4

🔝

string.truncate <text> <length> <ellipsis>?

Truncates a string down to the number of characters passed as the first parameter. An ellipsis (...) is appended to the truncated string and is included in the character count

• text: The input string
• length: The maximum length of the output string, including the length of the ellipsis
• ellipsis: The ellipsis to append to the end of the truncated string

The truncated input string

input

{{ "The cat came back the very next day" | string.truncate 13 }}

output

The cat ca...

🔝

string.truncatewords <text> <count> <ellipsis>?

Truncates a string down to the number of words passed as the first parameter. An ellipsis (...) is appended to the truncated string.

• text: The input string
• count: The number of words to keep from the input text string before appending the ellipsis
• ellipsis: The ellipsis to append to the end of the truncated string

The truncated input string

input

{{ "The cat came back the very next day" | string.truncatewords 4 }}

output

The cat came back...

🔝

string.upcase <text>

Converts the string to uppercase

• text: The input string

The input string upper case

input

{{ "test" | string.upcase }}

output

TEST

🔝

string.md5 <text>

Computes the md5 hash of the input string

• text: The input string

The md5 hash of the input string

input

{{ "test" | string.md5 }}

output

098f6bcd4621d373cade4e832627b4f6

🔝

string.sha1 <text>

Computes the sha1 hash of the input string

• text: The input string

The sha1 hash of the input string

input

{{ "test" | string.sha1 }}

output

a94a8fe5ccb19ba61c4c0873d391e987982fbbd3

🔝

string.sha256 <text>

Computes the sha256 hash of the input string

• text: The input string

The sha256 hash of the input string

input

{{ "test" | string.sha256 }}

output

9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08

🔝

string.hmac_sha1 <text> <secretKey>

Converts a string into a SHA-1 hash using a hash message authentication code (HMAC). Pass the secret key for the message as a parameter to the function.

• text: The input string
• secretKey: The secret key

The SHA-1 hash of the input string using a hash message authentication code (HMAC)

input

{{ "test" | string.hmac_sha1 "secret" }}

output

1aa349585ed7ecbd3b9c486a30067e395ca4b356

🔝

string.hmac_sha256 <text> <secretKey>

Converts a string into a SHA-256 hash using a hash message authentication code (HMAC). Pass the secret key for the message as a parameter to the function.

• text: The input string
• secretKey: The secret key

The SHA-256 hash of the input string using a hash message authentication code (HMAC)

input

{{ "test" | string.hmac_sha256 "secret" }}

output

0329a06b62cd16b33eb6792be8c60b158d89a2ee3a876fce9a881ebb488c0914

🔝

string.pad_left <text> <width>

Pads a string with leading spaces to a specified total length.

• text: The input string
• width: The number of characters in the resulting string

The input string padded

input

hello{{ "world" | string.pad_left 10 }}

output

hello     world

🔝

string.pad_right <text> <width>

Pads a string with trailing spaces to a specified total length.

• text: The input string
• width: The number of characters in the resulting string

The input string padded

input

{{ "hello" | string.pad_right 10 }}world

output

hello     world

🔝

string.base64_encode <text>

Encodes a string to its Base64 representation. Its character encoded will be UTF-8.

• text: The string to encode

The encoded string

input

{{ "hello" | string.base64_encode }}

output

aGVsbG8=

🔝

string.base64_decode <text>

Decodes a Base64-encoded string to a byte array. The encoding of the bytes is assumed to be UTF-8.

• text: The string to decode

The decoded string

input

{{ "aGVsbG8=" | string.base64_decode }}

output

hello

🔝

string.index_of <text> <search> <startIndex>? <count>? <stringComparison>?

Reports the zero-based index of the first occurrence of the specified string in this instance. The search starts at a specified character position and examines a specified number of character positions.

• text: The string to search
• search: The string to find the index of.
• startIndex: If provided, the search starting position. If , search will start at the beginning of .
• count: If provided, the number of character positions to examine. If , all character positions will be considered.
• stringComparison: If provided, the comparison rules for the search. If , Allowed values are one of the following: 'CurrentCulture', 'CurrentCultureIgnoreCase', 'InvariantCulture', 'InvariantCultureIgnoreCase', 'Ordinal', 'OrdinalIgnoreCase'

The zero-based index position of the parameter from the start of if is found, or -1 if it is not. If value is , the return value is (if is not provided, the return value would be zero).

🔝

A timespan object represents a time interval.

• timespan.from_days
• timespan.from_hours
• timespan.from_minutes
• timespan.from_seconds
• timespan.from_milliseconds
• timespan.parse

🔝

timespan.from_days <days>

Returns a timespan object that represents a days interval

• days: The days.

A timespan object

input

{{ (timespan.from_days 5).days }}

output

5

🔝

timespan.from_hours <hours>

Returns a timespan object that represents a hours interval

• hours: The hours.

A timespan object

input

{{ (timespan.from_hours 5).hours }}

output

5

🔝

timespan.from_minutes <minutes>

Returns a timespan object that represents a minutes interval

• minutes: The minutes.

A timespan object

input

{{ (timespan.from_minutes 5).minutes }}

output

5

🔝

timespan.from_seconds <seconds>

Returns a timespan object that represents a seconds interval

• seconds: The seconds.

A timespan object

input

{{ (timespan.from_seconds 5).seconds }}

output

5

🔝

timespan.from_milliseconds <millis>

Returns a timespan object that represents a milliseconds interval

• millis: The milliseconds.

A timespan object

input

{{ (timespan.from_milliseconds 5).milliseconds }}

output

5

🔝

timespan.parse <text>

Parses the specified input string into a timespan object.

• text: A timespan text

A timespan object parsed from timespan

Note: This document was automatically generated from the sourcecode using Scriban.DocGen program