Array functions

Modified on Thu, 30 May at 10:34 AM

You can use array functions to transform array data. Array functions can, for example, search and sort the items in an array, perform mathematical operations, convert arrays to collections, reorder the items in an array, and more. Below is a list of supported array functions and a description what of each function does.

add (array; value1; value2; ...)

Adds values specified in parameters to an array and returns that array.

contains (array; value)

Verifies if an array contains the value.

deduplicate (array)

Removes duplicates from an array.

distinct (array; [key])

Removes duplicates inside an array. Use the key argument to access properties inside complex objects. To access nested properties, use dot notation. The first item in an array is index 1.

distinct( Contacts[] ; name )

= Removes duplicates inside an array of contacts by comparing the name property.

first (array)

Returns the first element of an array.

flatten (array)

Creates a new array with all sub-array elements concatenated into it recursively up to the specified depth.

More details about flatten function can be found at the Array.prototype.flat documentation.

join (array; separator)

Concatenates all the items of an array into a string, using a specified separator between each item.

keys (object)

Returns an array of a given object's or array's properties.

last (array)

Returns the last element of an array.

length (array)

Returns the number of items in an array.

map (complex array; key;[key for filtering];[possible values for filtering separated by a comma])

Returns a primitive array containing values of a complex array. Allows filtering values. Use raw variable names for keys.

map( Emails[] ; email )

= Returns a primitive array with emails.

map( Emails[] ; email ; label ; work,home )

= Returns a primitive array with emails that have a label equal to work or home.

merge (array1; array2; ...)

Merges two or more arrays into one array.

remove (array; value1; value2; ...)

Removes values specified in the parameters of an array. Effective only in case of primitive arrays of text or numbers.

reverse (array)

The first element of the array becomes the last element and vice versa.

shuffle (array)

Shuffles (randomly reorders) elements of an array.

slice (array; start; [end])

Returns a new array containing only selected items. The first item in the array has an index of 0.

sort (array; [order]; [key])

Sorts values of an array. The valid values of the order parameter are:

asc (default) - ascending order: 1, 2, 3, ... for type Number. A, B, C, a, b, c, ... for type Text.
desc - descending order: ..., 3, 2, 1 for type Number. ..., c, b, a, C, B, A for type Text.
asc ci - case insensitive ascending order: A, a, B, b, C, c, ... for type Text.
desc ci - case insensitive descending order: ..., C, c, B, b, A, a for type Text.

Use the key parameter to access properties inside complex objects. Use raw variable names for keys. To access nested properties, use dot notation. The first item in an array is index 1.

Example 2. sort( Contacts[] ; name )

Sorts an array of contacts by the name property in default ascending order.

Example 3. sort( Contacts[] ; desc ; name )

Sorts an array of contacts by the name property in descending order.

Example 4. sort( Contacts[] ; asc ci ; name )

Sorts an array of contacts by the name property in case insensitive ascending order.

Example 5. sort( Emails[] ; sender.name )

Sorts an array of emails by the sender.name property.

toArray (collection)

Converts a collection into an array of key-value collections.

toCollection (array; key; value)

Converts an array containing objects with key-value pairs into a collection.