Overview
Provides information about collections of items.
Details
Name: | Collection Supplier |
---|---|
Prefix: | collection(optional) |
Supported Content: | Collections, such as lists, sets and arrays. |
Provided By: |
Supported Keys
List of keys that the supplier will return a value for.
Key | Content Types | Return Type | Description |
size | Collection | The number of items in the collection. | |
is empty | Collection | Test if the collection is empty. | |
first | Collection | Anything | Returns the first item in the collection, if anything is present. FROM 2.0.0+ If there is only one item in the collection then you must use this parameter |
last | Collection | Anything | Returns the last item in the collection, if anything is present. FROM 2.0.0+ |
[X] | Collection | Anything | Returns the X'th item in the collection, where X is a number between 1 and 'size'. FROM 2.0.0+ |
join with [X] | Collection | Joins the 'to string' value of all the collection contents into a Text FROM 3.0.0+
| |
random | Collection | Anything | Returns a random item from the provided list of elements. FROM 3.1.0+ |
shuffle | Collection | Collection | Returns the collection of items but scrambles the order of the elements. FROM 3.1.0+ |
reverse | Collection | Collection | Returns the collection of items in reverse order. FROM 3.2.0+ |
collect [X] | Collection | Collection | Returns a collection of the same length made up of sub-values of each item in this collection with the specified keyword of 'X'. FROM 4.0.0+ |