Array functions

Last update: January 10, 2025

join (array; separator)

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

length (array)

Returns the number of items in an array.

keys (object)

Returns an array of the properties of a given object or array.

slice (array; start; [end])

Returns a new array containing only selected items.

merge (array1; array2; …)

Merges one or more arrays into one array.

contains (array; value)

Verifies if an array contains the value.

remove (array; value1; value2; …)

Removes values specified in the parameters of an array. This function is effective only on primitive arrays of text or numbers.

add (array; value1; value2; …)

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

map (complex array; key;[key for filtering];[possible values for filtering])

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

Examples:

  • map(Emails[];email)

    Returns a primitive array with emails

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

    Returns a primitive array with emails having a label equal to work or home

For more information, see Map an array or array element.

shuffle

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.

Examples:

  • sort(Contacts[];name)

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

  • sort(Contacts[];desc;name)

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

  • sort(Contacts[];asc ci;name)

    Sorts an array of contacts by the “name” property in case-insensitive ascending order

  • sort(Emails[];sender.name)

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

reverse (array)

The first element of the array becomes the last element, the second becomes the next-to-last, and so on.

flatten (array)

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

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.

Example: distinct(Contacts[];name)

Removes duplicates inside an array of contacts by comparing the “name” property

toCollection

toArray

This function converts a collection into an array of key-value pairs.

Examples:

Given the collection

{ key1: "value1", key2: "value2:}

The function

toArray({ key1: "value1", key2: "value2:})

Returns the array of key-value pairs

[{ key1: "value1"}, { key2: "value2"}]

arrayDifference [array1, array2, mode]

Returns the difference between two arrays.

Enter one of the following values for the mode parameter.

  • classic: Returns a new array that contains all elements of array1 that do not exist in array2.

  • symmetric: Returns an array of elements that are not common to both arrays.

    In other words, the function returns an array that contains all of the elements of array1 that do not exist in array2, and all of the elements of array2 that do not exist in array1.