Skip to content

object.md

Latest commit

 

History

History
1549 lines (1439 loc) · 32.9 KB

object.md

File metadata and controls

1549 lines (1439 loc) · 32.9 KB

Custom Object Block Helpers

These block helpers allow for querying, filtering, and comparing objects.

Helpers.Object.Compare
Summary Compare two objects
Returns Whether or not operation evaluates successfully
Remarks When trying to do a numeric comparison, if both inputs are not numeric a string comparison will occur.
Parameters
lvalue Left object
operatorType Operator to perform, if not specified will default to =. Supported operators are =, !=, <, <=, >, >=
rvalue Right object

Example

Context

{
    "a": 0,
    "b": 10
}

Usage

<strong>result:</strong>
{{#Helpers.Object.Compare a b}}
    <strong>True</strong>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Compare}}

{{#Helpers.Object.Compare a "<" b}}
    <strong>True</strong>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Compare}}

{{#Helpers.Object.Compare b ">" "example"}}
    <strong>True</strong>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Compare}}

Returns

<strong>result:</strong>
<strong>False</strong>

<strong>True</strong>

<strong>False</strong>

Helpers.Object.Distinct
Summary Return a collection of distinct elements from an array
Returns Updated collection of distinct elements
Remarks If object is not an array, this will drop into the else block. Note: this can be used with an array of maps/objects, it does not need to be an array of simple types(string, numeric, bool, etc..)
Parameters
array Array of objects to make distinct

Example

Context

{
    "array": [
        "one",
        "two",
        "two",
        "two",
        "three"
    ],
    "badInput": {
        "something": true
    }
}

Usage

<strong>result:</strong>
{{#Helpers.Object.Distinct array}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Distinct}}

{{#Helpers.Object.Distinct badInput}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Distinct}}

Returns

<strong>result:</strong>
<strong>True</strong>
<ul>
    <li>Value: one</li>
    <li>Value: two</li>
    <li>Value: three</li>
</ul>

<strong>False</strong>

Helpers.Object.DistinctBy
Summary Return a collection of distinct properties from an array
Returns Updated collection of distinct elements
Remarks If input is not an array, this will drop into the else block. Note: this can be used with an array of maps/objects, it does not need to be an array of simple types(string, numeric, bool, etc..)
If property is not found, this will return an empty array
If property exists in some elements, but not others, this will return only those elements that contain the property
Parameters
input Array of objects to make distinct
property Property to match on

Example

Context

{
    "array": [
        {
            "id": 1,
            "name": "test1",
            "type": {
                "id": 5,
                "name": "type1"
            }
        },
        {
            "id": 2,
            "name": "test2",
            "type": {
                "id": 5,
                "name": "type1",
                "color": "blue"
            }
        },
        {
            "id": 3,
            "name": "test2",
            "type": {
                "id": 6,
                "name": "type2",
                "color": "red"
            }
        },
        {
            "id": 4,
            "name": "test3",
            "type": {
                "id": 7,
                "name": "type3",
                "color": "red"               
            }
        }
    ],
    "notArray": {
        "id": 1
    }
}

Usage

<strong>Direct Property:</strong>
{{#Helpers.Object.DistinctBy array "name"}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this.name}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.DistinctBy}}

<strong>Nested Property:</strong>
{{#Helpers.Object.DistinctBy array "type.id"}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this.type.id}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.DistinctBy}}

<strong>Property Doesen't Exist:</strong>
{{#Helpers.Object.DistinctBy array "doesnotexist"}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this.id}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.DistinctBy}}

<strong>Property Exists in Some Elements:</strong>
{{#Helpers.Object.DistinctBy array "type.color"}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this.id}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.DistinctBy}}

<strong>Input Not an Array:</strong>
{{#Helpers.Object.DistinctBy notArray "id"}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this.id}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.DistinctBy}}

Returns

<strong>Direct Property:</strong>
<strong>True</strong>
<ul>
    <li>Value: test1</li>
    <li>Value: test2</li>
    <li>Value: test3</li>
</ul>

<strong>Nested Property:</strong>
<strong>True</strong>
<ul>
    <li>Value: 5</li>
    <li>Value: 6</li>
    <li>Value: 7</li>
</ul>

<strong>Property Doesen't Exist:</strong>
<strong>True</strong>
<ul>
</ul>

<strong>Property Exists in Some Elements:</strong>
<strong>True</strong>
<ul>
    <li>Value: 2</li>
    <li>Value: 3</li>
</ul>

<strong>Input Not an Array:</strong>
<strong>False</strong>

Helpers.Object.Filter
Summary Filters an array of objects given some expression
Returns Array of matching objects
Remarks
Parameters
input Array to filter
expression Expression to filter by
ignoreCase Whether or not to ignore case, defaults to false

Example

Context

{
    "objects": [
        {
            "id": 1,
            "name": "test-1",
            "type": "thing",
            "moreData": "more",
            "meta": {
                "name": "data"
            }
        },
        {
            "id": 2,
            "name": "test-2",
            "type": "thing",
            "price": 100.0,
            "meta": {
                "name": "data"
            }
        },
        {
            "id": 3,
            "name": "test-3",
            "type": "something else"
        }
    ]
}

Usage

<strong>result:</strong>
<ul>
    {{#Helpers.Object.Filter objects "type=thing"}}
        {{#each this}}
            {{#each this}}
                <li>Key: {{@key}}, Value: {{this}}</li>
            {{/each}}

        {{/each}}
    {{else}}
        <li>Failed to find match</li>
    {{/Helpers.Object.Filter}}
</ul>

<ul>
    {{#Helpers.Object.Filter objects "meta.name=data"}}
        {{#each this}}
            {{#each this}}
                <li>Key: {{@key}}, Value: {{this}}</li>
            {{/each}}

        {{/each}}
    {{else}}
        <li>Failed to find match</li>
    {{/Helpers.Object.Filter}}
</ul>

<ul>
    {{#Helpers.Object.Filter objects "meta.name=Data"}}
        {{#each this}}
            {{#each this}}
                <li>Key: {{@key}}, Value: {{this}}</li>
            {{/each}}

        {{/each}}
    {{else}}
        <li>Failed to find match</li>
    {{/Helpers.Object.Filter}}
</ul>

<ul>
    {{#Helpers.Object.Filter objects "meta.name=data AND price > 10" true}}
        {{#each this}}
            {{#each this}}
                <li>Key: {{@key}}, Value: {{this}}</li>
            {{/each}}

        {{/each}}
    {{else}}
        <li>Failed to find match</li>
    {{/Helpers.Object.Filter}}
</ul>

<ul>
    {{#Helpers.Object.Filter objects "(meta.name=data AND price > 10) OR id = 3" true}}
        {{#each this}}
            {{#each this}}
                <li>Key: {{@key}}, Value: {{this}}</li>
            {{/each}}

        {{/each}}
    {{else}}
        <li>Failed to find match</li>
    {{/Helpers.Object.Filter}}
</ul>

Returns

<strong>result:</strong>
<ul>
    <li>Key: id, Value: 1</li>
    <li>Key: name, Value: test-1</li>
    <li>Key: type, Value: thing</li>
    <li>Key: moreData, Value: more</li>
    <li>Key: meta, Value: System.Dynamic.System.Collections.Generic.Dictionary`2[System.String,System.Object]</li>

    <li>Key: id, Value: 2</li>
    <li>Key: name, Value: test-2</li>
    <li>Key: type, Value: thing</li>
    <li>Key: price, Value: 100</li>
    <li>Key: meta, Value: System.Dynamic.System.Collections.Generic.Dictionary`2[System.String,System.Object]</li>
</ul>

<ul>
    <li>Key: id, Value: 1</li>
    <li>Key: name, Value: test-1</li>
    <li>Key: type, Value: thing</li>
    <li>Key: moreData, Value: more</li>
    <li>Key: meta, Value: System.Dynamic.System.Collections.Generic.Dictionary`2[System.String,System.Object]</li>

    <li>Key: id, Value: 2</li>
    <li>Key: name, Value: test-2</li>
    <li>Key: type, Value: thing</li>
    <li>Key: price, Value: 100</li>
    <li>Key: meta, Value: System.Dynamic.System.Collections.Generic.Dictionary`2[System.String,System.Object]</li>
</ul>

<ul>
    <li>Failed to find match</li>
</ul>

<ul>
    <li>Key: id, Value: 2</li>
    <li>Key: name, Value: test-2</li>
    <li>Key: type, Value: thing</li>
    <li>Key: price, Value: 100</li>
    <li>Key: meta, Value: System.Dynamic.System.Collections.Generic.Dictionary`2[System.String,System.Object]</li>
</ul>

<ul>
    <li>Key: id, Value: 2</li>
    <li>Key: name, Value: test-2</li>
    <li>Key: type, Value: thing</li>
    <li>Key: price, Value: 100</li>
    <li>Key: meta, Value: System.Dynamic.System.Collections.Generic.Dictionary`2[System.String,System.Object]</li>

    <li>Key: id, Value: 3</li>
    <li>Key: name, Value: test-3</li>
    <li>Key: type, Value: something else</li>
</ul>

Helpers.Object.IsFirst
Summary Determine whether or not the object passed in is the first element in the passed in array
Returns Whether or not the object is the first element in the array
Remarks
Parameters
array Array of objects to inspect
object Object to match on

Example

Context

{
    "array": [
        "one",
        "two",
        "three"
    ]
}

Usage

<strong>result:</strong>
{{#Helpers.Object.IsFirst array "one"}}
    <strong>True</strong>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.IsFirst}}

{{#Helpers.Object.IsFirst array "two"}}
    <strong>True</strong>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.IsFirst}}

Returns

<strong>result:</strong>
<strong>True</strong>

<strong>False</strong>

Helpers.Object.IsLast
Summary Determine whether or not the object passed in is the last element in the passed in array
Returns Whether or not the object is the last element in the array
Remarks
Parameters
array Array of objects to inspect
object Object to match on

Example

Context

{
    "array": [
        "one",
        "two",
        "three"
    ]
}

Usage

<strong>result:</strong>
{{#Helpers.Object.IsLast array "one"}}
    <strong>True</strong>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.IsLast}}

{{#Helpers.Object.IsLast array "three"}}
    <strong>True</strong>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.IsLast}}

Returns

<strong>result:</strong>
<strong>False</strong>

<strong>True</strong>

Helpers.Object.Lookup
Summary Pull object by key or index from a dynamic object or array
Returns Object that is found
Remarks
Parameters
input Object/array to pull from
lookup Key/index to look for

Example

Context

{
    "objects": {
        "thing1": {
            "id": 1,
            "name": "test-1"
        },
        "thing2": {
            "id": 2,
            "name": "test-2"
        },
        "thing3": {
            "id": 3,
            "name": "test-3"
        }
    }
}

Usage

<strong>result:</strong>
<ul>
    {{#Helpers.Object.Lookup objects "thing1"}}
        {{#each this}}
            <li>Key: {{@key}}, Value: {{this}}</li>
        {{/each}}
    {{else}}
        <li>Failed to find match</li>
    {{/Helpers.Object.Lookup}}
</ul>
<ul>
    {{#Helpers.Object.Lookup objects "thing2"}}
        {{#each this}}
            <li>Key: {{@key}}, Value: {{this}}</li>
        {{/each}}
    {{else}}
        <li>Failed to find match</li>
    {{/Helpers.Object.Lookup}}
</ul>
<ul>
    {{#Helpers.Object.Lookup objects "something"}}
        {{#each this}}
            <li>Key: {{@key}}, Value: {{this}}</li>
        {{/each}}
    {{else}}
        <li>Failed to find match</li>
    {{/Helpers.Object.Lookup}}
</ul>

Returns

<strong>result:</strong>
<ul>
    <li>Key: id, Value: 1</li>
    <li>Key: name, Value: test-1</li>
</ul>
<ul>
    <li>Key: id, Value: 2</li>
    <li>Key: name, Value: test-2</li>
</ul>
<ul>
    <li>Failed to find match</li>
</ul>

Helpers.Object.OrderBy
Summary Return a collection of elements ordered sequentially by the matching property value
Returns A sequenced collection of elements
Remarks If object is not an array, this will drop into the else block. Note: this can be used with an array of maps/objects, it does not need to be an array of simple types(string, numeric, bool, etc..)
If property is not found, this will return the original collection
Parameters
input Array of elements to sequence
property Property to match on

Example

Context

{
    "array": [
        {
            "id": 3,
            "name": "test3",
            "price": 10.50,
            "type": {
                "id": 5,
                "name": "type1"
            }
        },
        {
            "id": 1,
            "name": "test1",
            "price": 60.90,
            "type": {
                "id": 6,
                "name": "type2"
            }
        },
        {
            "id": 2,
            "name": "test2",
            "price": 30.00,
            "type": {
                "id": 7,
                "name": "type1"
            }
        },
        {
            "id": 4,
            "name": "test4",
            "price": 110.00,
            "type": {
                "id": 5,
                "name": "type3"              
            }
        }
    ],
    "notArray": {
        "id": 1
    }
}

Usage

<strong>result:</strong>
<strong>Direct String Property:</strong>
{{#Helpers.Object.OrderBy array "name"}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this.name}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.OrderBy}}

<strong>Direct Decimal Property:</strong>
{{#Helpers.Object.OrderBy array "price"}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this.name}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.OrderBy}}

<strong>Nested Property Result:</strong>
{{#Helpers.Object.OrderBy array "type.id"}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this.name}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.OrderBy}}

<strong>Property Doesen't Exist Result:</strong>
{{#Helpers.Object.OrderBy array "doesnotexist"}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this.name}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.OrderBy}}

<strong>Input Not an Array Result:</strong>
{{#Helpers.Object.OrderBy notArray "id"}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this.name}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.OrderBy}}

Returns

<strong>Direct String Property:</strong>
<strong>True</strong>
<ul>
    <li>Value: test1</li>
    <li>Value: test2</li>
    <li>Value: test3</li>
    <li>Value: test4</li>
</ul>

<strong>Direct Decimal Property:</strong>
<strong>True</strong>
<ul>
    <li>Value: test3</li>
    <li>Value: test2</li>
    <li>Value: test1</li>
    <li>Value: test4</li>
</ul>

<strong>Nested Property Result:</strong>
<strong>True</strong>
<ul>
    <li>Value: test3</li>
    <li>Value: test4</li>
    <li>Value: test1</li>
    <li>Value: test2</li>
</ul>

<strong>Property Doesen't Exist Result:</strong>
<strong>True</strong>
<ul>
    <li>Value: test3</li>
    <li>Value: test1</li>
    <li>Value: test2</li>
    <li>Value: test4</li>
</ul>

<strong>Input Not an Array Result:</strong>
<strong>False</strong>

Helpers.Object.OrderByDescending
Summary Return a collection of elements in descending order by the matching property value
Returns A sequenced collection of elements
Remarks If object is not an array, this will drop into the else block. Note: this can be used with an array of maps/objects, it does not need to be an array of simple types(string, numeric, bool, etc..)
If property is not found, this will return the original collection
Parameters
input Array of elements to sequence
property Property to match on

Example

Context

{
    "array": [
        {
            "id": 3,
            "name": "test3",
            "price": 10.50,
            "type": {
                "id": 5,
                "name": "type1"
            }
        },
        {
            "id": 1,
            "name": "test1",
            "price": 60.90,
            "type": {
                "id": 6,
                "name": "type2"
            }
        },
        {
            "id": 2,
            "name": "test2",
            "price": 30.00,
            "type": {
                "id": 7,
                "name": "type1"
            }
        },
        {
            "id": 4,
            "name": "test4",
            "price": 110.00,
            "type": {
                "id": 5,
                "name": "type3"              
            }
        }
    ],
    "notArray": {
        "id": 1
    }
}

Usage

<strong>result:</strong>
<strong>Direct String Property:</strong>
{{#Helpers.Object.OrderByDescending array "name"}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this.name}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.OrderByDescending}}

<strong>Direct Decimal Property:</strong>
{{#Helpers.Object.OrderByDescending array "price"}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this.name}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.OrderByDescending}}

<strong>Nested Property Result:</strong>
{{#Helpers.Object.OrderByDescending array "type.id"}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this.name}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.OrderByDescending}}

<strong>Property Doesen't Exist Result:</strong>
{{#Helpers.Object.OrderByDescending array "doesnotexist"}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this.name}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.OrderByDescending}}

<strong>Input Not an Array Result:</strong>
{{#Helpers.Object.OrderByDescending notArray "id"}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this.name}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.OrderByDescending}}

Returns

<strong>Direct String Property:</strong>
<strong>True</strong>
<ul>
    <li>Value: test4</li>
    <li>Value: test3</li>
    <li>Value: test2</li>
    <li>Value: test1</li>
</ul>

<strong>Direct Decimal Property:</strong>
<strong>True</strong>
<ul>
    <li>Value: test4</li>
    <li>Value: test1</li>
    <li>Value: test2</li>
    <li>Value: test3</li>
</ul>

<strong>Nested Property Result:</strong>
<strong>True</strong>
<ul>
    <li>Value: test2</li>
    <li>Value: test1</li>
    <li>Value: test3</li>
    <li>Value: test4</li>
</ul>

<strong>Property Doesen't Exist Result:</strong>
<strong>True</strong>
<ul>
    <li>Value: test3</li>
    <li>Value: test1</li>
    <li>Value: test2</li>
    <li>Value: test4</li>
</ul>

<strong>Input Not an Array Result:</strong>
<strong>False</strong>

Helpers.Object.Page
Summary Return a collection of elements from an array, skipping N elements
Returns A single page worth of elements
Remarks If object is not an array, if page number is not passed in, or if page number or countPerPage are <= 0, this will drop into the else block. Note: this can be used with an array of maps/objects, it does not need to be an array of simple types(string, numeric, bool, etc..)
Parameters
array Array of objects to evaluate
pageNumber Page number
countPerPage Number of elements per page, default 0

Example

Context

{
    "array": [
        "one",
        "two",
        "three",
        "four",
        "five"
    ],
    "badInput": {
        "something": true
    }
}

Usage

<strong>result:</strong>
{{#Helpers.Object.Page array 2 2}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Page}}

{{#Helpers.Object.Page badInput 1 3}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Page}}

{{#Helpers.Object.Page array 1 -1}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Page}}

{{#Helpers.Object.Page array 0 2}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Page}}

Returns

<strong>result:</strong>
<strong>True</strong>
<ul>
    <li>Value: three</li>
    <li>Value: four</li>
</ul>

<strong>False</strong>

<strong>False</strong>

<strong>False</strong>

Helpers.Object.Reverse
Summary Reverses the order of an array
Returns An array with the element order reversed
Remarks If object is not an array, if page number is not passed in, or if page number or countPerPage are <= 0, this will drop into the else block. Note: this can be used with an array of maps/objects, it does not need to be an array of simple types(string, numeric, bool, etc..)
Parameters
input Array of elements to reverse

Example

Context

{
    "array": [
        "one",
        "two",
        "three",
        "four",
        "five"
    ],
    "badInput": {
        "something": true
    }
}

Usage

<strong>Result:</strong>
{{#Helpers.Object.Reverse array}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Reverse}}

<strong>Input Not an Array Result:</strong>
{{#Helpers.Object.Reverse badInput}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Reverse}}

Returns

<strong>Result:</strong>
<strong>True</strong>
<ul>
    <li>Value: five</li>
    <li>Value: four</li>
    <li>Value: three</li>
    <li>Value: two</li>
    <li>Value: one</li>
</ul>

<strong>Input Not an Array Result:</strong>
<strong>False</strong>

Helpers.Object.Select
Summary Return a collection of properties from an array
Returns Updated collection of elements
Remarks If input is not an array, this will drop into the else block. Note: this can be used with an array of maps/objects, it does not need to be an array of simple types(string, numeric, bool, etc..)
If property is not found, this will return an empty array
Parameters
input Array of objects to search
property Property to match on

Example

Context

{
    "array": [
        {
            "id": 1,
            "name": "test1",
            "type": {
                "id": 5,
                "name": "type1"
            }
        },
        {
            "id": 2,
            "name": "test2",
            "type": {
                "id": 5,
                "name": "type1",
                "color": "blue"
            }
        },
        {
            "id": 3,
            "name": "test2",
            "type": {
                "id": 6,
                "name": "type2",
                "color": "red"
            }
        },
        {
            "id": 4,
            "name": "test3",
            "type": {
                "id": 7,
                "name": "type3",
                "color": "red"               
            }
        }
    ],
    "notArray": {
        "id": 1
    }
}

Usage

<strong>Direct Property:</strong>
{{#Helpers.Object.Select array "name"}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Select}}

<strong>Object Property:</strong>
{{#Helpers.Object.Select array "type"}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this.id}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Select}}

<strong>Nested Property:</strong>
{{#Helpers.Object.Select array "type.name"}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Select}}

<strong>Property Exists in Some Elements:</strong>
{{#Helpers.Object.Select array "type.color"}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Select}}

<strong>Property Doesen't Exist:</strong>
{{#Helpers.Object.Select array "doesnotexist"}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Select}}

<strong>Input Not an Array:</strong>
{{#Helpers.Object.Select notArray "id"}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Select}}

Returns

<strong>Direct Property:</strong>
<strong>True</strong>
<ul>
    <li>Value: test1</li>
    <li>Value: test2</li>
    <li>Value: test2</li>
    <li>Value: test3</li>
</ul>

<strong>Object Property:</strong>
<strong>True</strong>
<ul>
    <li>Value: 5</li>
    <li>Value: 5</li>
    <li>Value: 6</li>
    <li>Value: 7</li>
</ul>

<strong>Nested Property:</strong>
<strong>True</strong>
<ul>
    <li>Value: type1</li>
    <li>Value: type1</li>
    <li>Value: type2</li>
    <li>Value: type3</li>
</ul>

<strong>Property Exists in Some Elements:</strong>
<strong>True</strong>
<ul>
    <li>Value: blue</li>
    <li>Value: red</li>
    <li>Value: red</li>
</ul>

<strong>Property Doesen't Exist:</strong>
<strong>True</strong>
<ul>
</ul>

<strong>Input Not an Array:</strong>
<strong>False</strong>

Helpers.Object.Skip
Summary Return a collection of elements from an array, skipping N elements
Returns Collection of elements, minus the ones that were skipped
Remarks If object is not an array, this will drop into the else block. Note: this can be used with an array of maps/objects, it does not need to be an array of simple types(string, numeric, bool, etc..)
Parameters
array Array of objects to evaluate
skipN Number of elements to skip

Example

Context

{
    "array": [
        "one",
        "two",
        "three"
    ],
    "badInput": {
        "something": true
    }
}

Usage

<strong>result:</strong>
{{#Helpers.Object.Skip array 2}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Skip}}

{{#Helpers.Object.Skip badInput 1}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Skip}}

Returns

<strong>result:</strong>
<strong>True</strong>
<ul>
    <li>Value: three</li>
</ul>

<strong>False</strong>

Helpers.Object.Sort
Summary Sort an array of elements
Returns A sorted array
Remarks If object is not an array, if page number is not passed in, or if page number or countPerPage are <= 0, this will drop into the else block.
This only works with arrays of simple types(string, numeric, bool, etc..). Sorting non-simple types will return an empty array.
Parameters
input Array of elements to sort

Example

Context

{
    "stringArray": [
        "one",
        "two",
        "three",
        "four",
        "five"
    ],
    "numericArray": [
        5,
        3,
        4,
        1,
        2
    ],
    "objectArray": [
        {
            "id": 2
        },
        {
            "id": 1
        }
    ],
    "badInput": {
        "something": true
    }
}

Usage

<strong>String Array:</strong>
{{#Helpers.Object.Sort stringArray}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Sort}}

<strong>Numeric Array:</strong>
{{#Helpers.Object.Sort numericArray}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Sort}}

<strong>Object Array:</strong>
{{#Helpers.Object.Sort objectArray}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Sort}}

<strong>Input Not an Array:</strong>
{{#Helpers.Object.Sort badInput}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Sort}}

Returns

<strong>String Array:</strong>
<strong>True</strong>
<ul>
    <li>Value: five</li>
    <li>Value: four</li>
    <li>Value: one</li>
    <li>Value: three</li>
    <li>Value: two</li>
</ul>

<strong>Numeric Array:</strong>
<strong>True</strong>
<ul>
    <li>Value: 1</li>
    <li>Value: 2</li>
    <li>Value: 3</li>
    <li>Value: 4</li>
    <li>Value: 5</li>
</ul>

<strong>Object Array:</strong>
<strong>True</strong>
<ul>
</ul>

<strong>Input Not an Array:</strong>
<strong>False</strong>

Helpers.Object.Take
Summary Return a collection of N elements from an array
Returns Collection of N elements
Remarks If object is not an array, this will drop into the else block. Note: this can be used with an array of maps/objects, it does not need to be an array of simple types(string, numeric, bool, etc..)
Parameters
array Array of objects to evaluate
takeN Number of elements to return

Example

Context

{
    "array": [
        "one",
        "two",
        "three"
    ],
    "badInput": {
        "something": true
    }
}

Usage

<strong>result:</strong>
{{#Helpers.Object.Take array 2}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Take}}

{{#Helpers.Object.Take badInput 1}}
    <strong>True</strong>
    <ul>
    {{#each this}}
        <li>Value: {{this}}</li>
    {{/each}}
    </ul>
{{else}}
    <strong>False</strong>
{{/Helpers.Object.Take}}

Returns

<strong>result:</strong>
<strong>True</strong>
<ul>
    <li>Value: one</li>
    <li>Value: two</li>
</ul>

<strong>False</strong>