$sum

Computes the sum of the values.

This function has multiple signatures

Signature 1

{{$sum array [format]}}

Computes the sum of numbers in an array.

Arguments

Name	Description	Type	Required
array	List of numbers to sum.	Number Array
format	Format string used to format the result	String

Example

Template

{{$sum hours_worked}}

Data

{
    "hours_worked": [3, 6, 4, 12]
}

Result

25

Returns

Returns the total.

Signature 2

{{$sum number1 number2 [...] [format]}}

Computes the sum of numbers passed as arguments.

Arguments

Name	Description	Type	Required
number1	The first number to sum.	Number
number2	The second number to sum.	Number
[...]	The remaining numbers to sum.	Number
format	Format string used to format the result	String

Example

Template

{{$sum subtotal discount tax}}

Data

{
    "subtotal": 150,
    "discount": -20,
    "tax": 6.50
}

Result

136.5

Returns

Returns the total.

Signature 3

{{$sum collection path [format]}}

Computes the sum of numbers within a collection (an array of objects).

Arguments

Name	Description	Type	Required
collection	An array of objects	Collection
path	Path to the number property on each object.	String
format	Format string used to format the result	String

Example

Template

{{$sum items "price"}}

Data

{
    "items": [
        { "name":"Rocket Skates", "price":160.3 },
        { "name":"Acme Glue", "price":15.6 },
        { "name":"Wing Suit", "price":699.99 },
    ]
}

Result

875.89

Returns

Returns the total.