This document describes the various built-in functions available in scriban.
array functionsdate functionshtml functionsmath functionsobject functionsregex functionsstring functionstimespan functionsarray functionsArray functions available through the object 'array' in scriban.
array.addarray.add_rangearray.compactarray.concatarray.cyclearray.firstarray.insert_atarray.joinarray.lastarray.limitarray.maparray.offsetarray.remove_atarray.reversearray.sizearray.sortarray.uniqarray.addarray.add <list> <value>
Adds a value to the input list.
list: The input listvalue: The value to add at the end of the listA new list with the value added
input
{{ [1, 2, 3] | array.add 4 }}
output
[1, 2, 3, 4]
array.add_rangearray.add_range <list1> <list2>
Concatenates two lists.
list1: The 1st input listlist2: The 2nd input listThe concatenation of the two input lists
input
{{ [1, 2, 3] | array.concat [4, 5] }}
output
[1, 2, 3, 4, 5]
array.compactarray.compact <list>
Removes any non-null values from the input list.
list: An input listReturns a list with null value removed
input
{{ [1, null, 3] | array.compact }}
output
[1, 3]
array.concatarray.concat <list1> <list2>
Concatenates two lists.
list1: The 1st input listlist2: The 2nd input listThe concatenation of the two input lists
input
{{ [1, 2, 3] | array.concat [4, 5] }}
output
[1, 2, 3, 4, 5]
array.cyclearray.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 listgroup: The group used. Default is nullReturns 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.firstarray.first <list>
Returns the first element of the input list.
list: The input listThe first element of the input list.
input
{{ [4, 5, 6] | array.first }}
output
4
array.insert_atarray.insert_at <list> <index> <value>
Inserts a value at the specified index in the input list.
list: The input listindex: The index in the list where to insert the elementvalue: The value to insertA new list with the element inserted.
input
{{ ["a", "b", "c"] | array.insert_at 2 "Yo" }}
output
[a, b, Yo, c]
array.joinarray.join <list> <delimiter>
Joins the element of a list separated by a delimiter string and return the concatenated string.
list: The input listdelimiter: The delimiter string to use to separate elements in the output stringA new list with the element inserted.
input
{{ [1, 2, 3] | array.join "|" }}
output
1|2|3
array.lastarray.last <list>
Returns the last element of the input list.
list: The input listThe last element of the input list.
input
{{ [4, 5, 6] | array.last }}
output
6
array.limitarray.limit <list> <count>
Returns a limited number of elments from the input list
list: The input listcount: The number of elements to return from the input listinput
{{ [4, 5, 6] | array.limit 2 }}
output
[4, 5]
array.maparray.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 listmember: The member to extract the value frominput
{{
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.offsetarray.offset <list> <index>
Returns the remaining of the list after the specified offset
list: The input listindex: The index of a list to return elementsinput
{{ [4, 5, 6, 7, 8] | array.offset 2 }}
output
[6, 7, 8]
array.remove_atarray.remove_at <list> <index>
Removes an element at the specified index from the input list
list: The input listindex: The index of a list to return elementsA 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.reversearray.reverse <list>
Reverses the input list
list: The input listA new list in reversed order.
input
{{ [4, 5, 6, 7] | array.reverse }}
output
[7, 6, 5, 4]
array.sizearray.size <list>
Returns the number of elements in the input list
list: The input listA number of elements in the input list.
input
{{ [4, 5, 6] | array.size }}
output
3
array.sortarray.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 listmember: 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.uniqarray.uniq <list>
Returns the unique elements of the input list.
list: The input listA list of unique elements of the input list.
input
{{ [1, 1, 4, 5, 8, 8] | array.uniq }}
output
[1, 4, 5, 8]
date functionsA datetime object represents an instant in time, expressed as a date and time of day.
| Name | Description |
|---|---|
.year |
Gets the year of a date object |
.month |
Gets the month of a date object |
.day |
Gets the day in the month of a date object |
.day_of_year |
Gets the day within the year |
.hour |
Gets the hour of the date object |
.minute |
Gets the minute of the date object |
.second |
Gets the second of the date object |
.millisecond |
Gets the millisecond of the date object |
The substract operation date1 - date2: Substract 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.nowdate.add_daysdate.add_monthsdate.add_yearsdate.add_hoursdate.add_minutesdate.add_secondsdate.add_millisecondsdate.parsedate.to_stringdate.nowdate.now
Returns a datetime object of the current time, including the hour, minutes, seconds and milliseconds.
input
{{ date.now.year }}
output
2018
date.add_daysdate.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_monthsdate.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_yearsdate.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_hoursdate.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_minutesdate.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_secondsdate.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_millisecondsdate.add_milliseconds <date> <millis>
Adds the specified number of milliseconds to the input date.
date: The date.millis: The milliseconds.A new date
date.parsedate.parse <text>
Parses the specified input string to a date object.
text: A text representing a date.A date object
input
{{ date.parse '2016/01/05' }}
output
05 Jan 2016
date.to_stringdate.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:
| Format | Result | Description |
|---|---|---|
"%a" |
"Thu" |
Name of week day in short form of the |
"%A" |
"Thursday" |
Week day in full form of the time |
"%b" |
"Sep" |
Month in short form of the time |
"%B" |
"September" |
Month in full form of the time |
"%c" |
Date and time (%a %b %e %T %Y) | |
"%C" |
"20" |
Century of the time |
"%d" |
"12" |
Day of the month of the time |
"%D" |
"09/12/13" |
Date (%m/%d/%y) |
"%e" |
"12" |
Day of the month, blank-padded ( 1..31) |
"%F" |
"2013-09-12" |
ISO 8601 date (%Y-%m-%d) |
"%h" |
"Sep" |
Alias for %b |
"%H" |
"22" |
Hour of the time in 24 hour clock format |
"%I" |
"10" |
Hour of the time in 12 hour clock format |
"%j" |
"255" |
Day of the year (001..366) (3 digits, left padded with zero) |
"%k" |
"22" |
Hour of the time in 24 hour clock format, blank-padded ( 0..23) |
"%l" |
"10" |
Hour of the time in 12 hour clock format, blank-padded ( 0..12) |
"%L" |
"000" |
Millisecond of the time (3 digits, left padded with zero) |
"%m" |
"09" |
Month of the time |
"%M" |
"49" |
Minutes of the time (2 digits, left padded with zero e.g 01 02) |
"%n" |
Newline character (\n) | |
"%N" |
"000000000" |
Nanoseconds of the time (9 digits, left padded with zero) |
"%p" |
"PM" |
Gives AM / PM of the time |
"%P" |
"pm" |
Gives am / pm of the time |
"%r" |
"10:49:27 PM" |
Long time in 12 hour clock format (%I:%M:%S %p) |
"%R" |
"22:49" |
Short time in 24 hour clock format (%H:%M) |
"%s" |
Number of seconds since 1970-01-01 00:00:00 +0000 | |
"%S" |
"27" |
Seconds of the time |
"%t" |
Tab character (\t) | |
"%T" |
"22:49:27" |
Long time in 24 hour clock format (%H:%M:%S) |
"%u" |
"4" |
Day of week of the time (from 1 for Monday to 7 for Sunday) |
"%U" |
"36" |
Week number of the current year, starting with the first Sunday as the first day of the first week (00..53) |
"%v" |
"12-SEP-2013" |
VMS date (%e-%b-%Y) (culture invariant) |
"%V" |
"37" |
Week number of the current year according to ISO 8601 (01..53) |
"%W" |
"36" |
Week number of the current year, starting with the first Monday as the first day of the first week (00..53) |
"%w" |
"4" |
Day of week of the time (from 0 for Sunday to 6 for Saturday) |
"%x" |
Preferred representation for the date alone, no time | |
"%X" |
Preferred representation for the time alone, no date | |
"%y" |
"13" |
Gives year without century of the time |
"%Y" |
"2013" |
Year of the time |
"%Z" |
"IST" |
Gives Time Zone of the time |
"%%" |
"%" |
Output the character % |
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` }}
output
05 Jan 2016
datetime: The input datetime to formatpattern: The date format pattern.culture: The culture used to format the datetimeA that represents this instance.
html functionsHtml functions available through the builtin object 'html'.
html.striphtml.strip <text>
Removes any HTML tags from the input string
text: The input stringThe input string removed with any HTML tags
input
{{ "<p>This is a paragraph</p>" | html.strip }}
output
This is a paragraph
html.escapehtml.escape <text>
Escapes a HTML input string (replacing & by &)
text: The input stringThe 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_encodehtml.url_encode <text>
Converts any URL-unsafe characters in a string into percent-encoded characters.
text: The input stringThe input string url encoded
input
{{ "john@liquid.com" | html.url_encode }}
output
john%40liquid.com
html.url_escapehtml.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 stringThe input string url escaped
input
{{ "<hello> & <scriban>" | html.url_escape }}
output
%3Chello%3E%20&%20%3Cscriban%3E
math functionsMath functions available through the object 'math' in scriban.
math.absmath.ceilmath.divided_bymath.floormath.formatmath.is_numbermath.minusmath.modulomath.plusmath.roundmath.timesmath.absmath.abs <value>
Returns the absolute value of a specified number.
value: The input valueThe absolute value of the input value
input
{{ -15.5| math.abs }}
{{ -5| math.abs }}
output
15.5
5
math.ceilmath.ceil <value>
Returns the smallest integer greater than or equal to the specified number.
value: The input valueThe smallest integer greater than or equal to the specified number.
input
{{ 4.6 | math.ceil }}
{{ 4.3 | math.ceil }}
output
5
5
math.divided_bymath.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 valuedivisor: The divisor valueThe 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.floormath.floor <value>
Returns the largest integer less than or equal to the specified number.
value: The input valueThe largest integer less than or equal to the specified number.
input
{{ 4.6 | math.floor }}
{{ 4.3 | math.floor }}
output
4
4
math.formatmath.format <value> <format> <culture>?
Formats a number value with specified .NET standard numeric format strings
value: The input valueformat: The format string.culture: The culture as a string (e.g en-US). By default the culture from is usedThe largest integer less than or equal to the specified number.
input
{{ 255 | math.format "X4" }}
output
00FF
math.is_numbermath.is_number <value>
Returns a boolean indicating if the input value is a number
value: The input valuetrue if the input value is a number; otherwise false.
input
{{ 255 | math.is_number }}
{{ "yo" | math.is_number }}
output
true
false
math.minusmath.minus <value> <with>
Substracts from the input value the with value
value: The input valuewith: The with value to substract from valueThe results of the substraction: value - with
input
{{ 255 | math.minus 5}}
output
250
math.modulomath.modulo <value> <with>
Performs the modulo of the input value with the with value
value: The input valuewith: The with value to module valueThe results of the modulo: value % with
input
{{ 11 | math.modulo 10}}
output
1
math.plusmath.plus <value> <with>
Performs the addition of the input value with the with value
value: The input valuewith: The with value to add tovalueThe results of the addition: value + with
input
{{ 1 | math.plus 2}}
output
3
math.roundmath.round <value> <precision: 0>?
Rounds a value to the nearest integer or to the specified number of fractional digits.
value: The input valueprecision: 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.timesmath.times <value> <with>
Performs the multiplication of the input value with the with value
value: The input valuewith: The with value to multiply tovalueThe results of the multiplication: value * with
input
{{ 2 | math.times 3}}
output
6
object functionsObject functions available through the builtin object 'object'.
object.defaultobject.formatobject.has_keyobject.has_valueobject.keysobject.sizeobject.typeofobject.valuesobject.defaultobject.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 alue 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.formatobject.format <value> <format> <culture>?
Formats an object using specified format.
value: The input valueformat: The format string.culture: The culture as a string (e.g en-US). By default the culture from is usedinput
{{ 255 | object.format "X4" }}
{{ 1523 | object.format "N" "fr-FR" }}
output
00FF
1 523,00
object.has_keyobject.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_valueobject.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.keysobject.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.sizeobject.size <value>
Returns the size of the input object.
value: The input object.The size of the input object.
input
{{ [1, 2, 3] | object.size }}
output
3
object.typeofobject.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.valuesobject.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]
regex functionsFunctions exposed through regex builtin object.
regex.escaperegex.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.matchregex.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.replaceregex.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.splitregex.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.unescaperegex.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 functionsString functions available through the builtin object 'string`.
string.appendstring.capitalizestring.capitalizewordsstring.containsstring.downcasestring.ends_withstring.handleizestring.lstripstring.pluralizestring.prependstring.removestring.remove_firststring.replacestring.replace_firststring.rstripstring.sizestring.slicestring.slice1string.splitstring.starts_withstring.stripstring.strip_newlinesstring.to_intstring.to_longstring.to_floatstring.to_doublestring.truncatestring.truncatewordsstring.upcasestring.md5string.sha1string.sha256string.hmac_sha1string.hmac_sha256string.pad_leftstring.pad_rightstring.appendstring.append <text> <with>
Concatenates two strings
text: The input stringwith: The text to appendThe two strings concatenated
input
{{ "Hello" | string.append " World" }}
output
Hello World
string.capitalizestring.capitalize <text>
Converts the first character of the passed string to a upper case character.
text: The input stringThe capitalized input string
input
{{ "test" | string.capitalize }}
output
Test
string.capitalizewordsstring.capitalizewords <text>
Converts the first character of each word in the passed string to a upper case character.
text: The input stringThe capitalized input string
input
{{ "This is easy" | string.capitalizewords }}
output
This Is Easy
string.containsstring.contains <text> <value>
Returns a boolean indicating whether the input string contains the specified string value.
text: The input stringvalue: The string to look for if text contains the string value
input
{{ "This is easy" | string.contains "easy" }}
output
true
string.downcasestring.downcase <text>
Converts the string to lower case.
text: The input stringThe input string lower case
input
{{ "TeSt" | string.downcase }}
output
test
string.ends_withstring.ends_with <text> <value>
Returns a boolean indicating whether the input string ends with the specified string value.
text: The input stringvalue: The string to look for if text ends with the specified string value
input
{{ "This is easy" | string.ends_with "easy" }}
output
true
string.handleizestring.handleize <text>
Returns a url handle from the input string.
text: The input stringA url handle
input
{{ '100% M & Ms!!!' | string.handleize }}
output
100-m-ms
string.lstripstring.lstrip <text>
Removes any whitespace characters on the left side of the input string.
text: The input stringThe 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.pluralizestring.pluralize <number> <singular> <plural>
Outputs the singular or plural version of a string based on the value of a number.
number: The number to checksingular: The singular string to return if number is == 1plural: The plural string to return if number is != 1The singular or plural string based on number
input
{{ products.size }} {{products.size | string.pluralize 'product' 'products' }}
output
7 products
string.prependstring.prepend <text> <by>
Concatenates two strings by placing the by string in from of the text string
text: The input stringby: The string to prepend to textThe two strings concatenated
input
{{ "World" | string.prepend "Hello " }}
output
Hello World
string.removestring.remove <text> <remove>
Removes all occurrences of a substring from a string.
text: The input stringremove: The substring to remove from the text stringThe input string with the all occurence of a substring removed
input
{{ "Hello, world. Goodbye, world." | string.remove "world" }}
output
Hello, . Goodbye, .
string.remove_firststring.remove_first <text> <remove>
Removes the first occurrence of a substring from a string.
text: The input stringremove: The first occurence of substring to remove from the text stringThe input string with the first occurence of a substring removed
input
{{ "Hello, world. Goodbye, world." | string.remove_first "world" }}
output
Hello, . Goodbye, world.
string.replacestring.replace <text> <match> <replace>
Replaces all occurrences of a string with a substring.
text: The input stringmatch: The substring to find in the text stringreplace: The substring used to replace the string matched by match in the input textThe input string replaced
input
{{ "Hello, world. Goodbye, world." | string.replace "world" "buddy" }}
output
Hello, buddy. Goodbye, buddy.
string.replace_firststring.replace_first <text> <match> <replace>
Replaces the first occurrence of a string with a substring.
text: The input stringmatch: The substring to find in the text stringreplace: The substring used to replace the string matched by match in the input textThe input string replaced
input
{{ "Hello, world. Goodbye, world." | string.replace_first "world" "buddy" }}
output
Hello, buddy. Goodbye, world.
string.rstripstring.rstrip <text>
Removes any whitespace characters on the right side of the input string.
text: The input stringThe 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.sizestring.size <text>
Returns the number of characters from the input string
text: The input stringThe length of the input string
input
{{ "test" | string.size }}
output
4
string.slicestring.slice <text> <start> <length: 0>?
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 stringstart: The starting index character where the slice should start from the input text stringlength: 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.slice1string.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 stringstart: The starting index character where the slice should start from the input text stringlength: 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.splitstring.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 stringmatch: The string used to split the input text stringAn 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_withstring.starts_with <text> <value>
Returns a boolean indicating whether the input string starts with the specified string value.
text: The input stringvalue: The string to look for if text starts with the specified string value
input
{{ "This is easy" | string.starts_with "This" }}
output
true
string.stripstring.strip <text>
Removes any whitespace characters on the left and right side of the input string.
text: The input stringThe 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_newlinesstring.strip_newlines <text>
Removes any line breaks/newlines from a string.
text: The input stringThe 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_intstring.to_int <text>
Converts a string to an integer
text: The input stringA 32 bit integer or null if conversion failed
input
{{ "123" | string.to_int + 1 }}
output
124
string.to_longstring.to_long <text>
Converts a string to a long 64 bit integer
text: The input stringA 64 bit integer or null if conversion failed
input
{{ "123678912345678" | string.to_long + 1 }}
output
123678912345679
string.to_floatstring.to_float <text>
Converts a string to a float
text: The input stringA 32 bit float or null if conversion failed
input
{{ "123.4" | string.to_float + 1 }}
output
124.4
string.to_doublestring.to_double <text>
Converts a string to a double
text: The input stringA 64 bit float or null if conversion failed
input
{{ "123.4" | string.to_double + 1 }}
output
124.4
string.truncatestring.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 stringlength: The maximum length of the output string, including the length of the ellipsisellipsis: The ellipsis to append to the end of the truncated stringThe truncated input string
input
{{ "The cat came back the very next day" | string.truncate 13 }}
output
The cat ca...
string.truncatewordsstring.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 stringcount: The number of words to keep from the input text string before appending the ellipsisellipsis: The ellipsis to append to the end of the truncated stringThe truncated input string
input
{{ "The cat came back the very next day" | string.truncatewords 4 }}
output
The cat came back...
string.upcasestring.upcase <text>
Converts the string to uppercase
text: The input stringThe input string upper case
input
{{ "test" | string.upcase }}
output
TEST
string.md5string.md5 <text>
Computes the md5 hash of the input string
text: The input stringThe md5 hash of the input string
input
{{ "test" | string.md5 }}
output
098f6bcd4621d373cade4e832627b4f6
string.sha1string.sha1 <text>
Computes the sha1 hash of the input string
text: The input stringThe sha1 hash of the input string
input
{{ "test" | string.sha1 }}
output
a94a8fe5ccb19ba61c4c0873d391e987982fbbd3
string.sha256string.sha256 <text>
Computes the sha256 hash of the input string
text: The input stringThe sha256 hash of the input string
input
{{ "test" | string.sha256 }}
output
9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08
string.hmac_sha1string.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 stringsecretKey: The secret keyThe SHA-1 hash of the input string using a hash message authentication code (HMAC)
input
{{ "test" | string.hmac_sha1 "secret" }}
output
1aa349585ed7ecbd3b9c486a30067e395ca4b356
string.hmac_sha256string.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 stringsecretKey: The secret keyThe SHA-256 hash of the input string using a hash message authentication code (HMAC)
input
{{ "test" | string.hmac_sha256 "secret" }}
output
0329a06b62cd16b33eb6792be8c60b158d89a2ee3a876fce9a881ebb488c0914
string.pad_leftstring.pad_left <text> <width>
Pads a string with leading spaces to a specified total length.
text: The input stringwidth: The number of characters in the resulting stringThe input string padded
input
hello{{ "world" | string.pad_left 10 }}
output
hello world
string.pad_rightstring.pad_right <text> <width>
Pads a string with trailing spaces to a specified total length.
text: The input stringwidth: The number of characters in the resulting stringThe input string padded
input
{{ "hello" | string.pad_right 10 }}world
output
hello world
timespan functionsA timespan object represents a time interval.
| Name | Description |
|---|---|
.days |
Gets the number of days of this interval |
.hours |
Gets the number of hours of this interval |
.minutes |
Gets the number of minutes of this interval |
.seconds |
Gets the number of seconds of this interval |
.milliseconds |
Gets the number of milliseconds of this interval |
.total_days |
Gets the total number of days in fractional part |
.total_hours |
Gets the total number of hours in fractional part |
.total_minutes |
Gets the total number of minutes in fractional part |
.total_seconds |
Gets the total number of seconds in fractional part |
.total_milliseconds |
Gets the total number of milliseconds in fractional part |
timespan.from_daystimespan.from_hourstimespan.from_minutestimespan.from_secondstimespan.from_millisecondstimespan.parsetimespan.from_daystimespan.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_hourstimespan.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_minutestimespan.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_secondstimespan.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_millisecondstimespan.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.parsetimespan.parse <text>
Parses the specified input string into a timespan object.
text: A timespan textA timespan object parsed from timespan
Note: This document was automatically generated from the sourcecode using
Scriban.DocGenprogram