Helpers

JavaScript API utility methods for managing arrays and objects.

Use these methods to format data as arrays and objects.

formatDataAsArray()

Formats data as an array of objects or an array of arrays.

Syntax

formatDataAsArray(data, outputArrayOfArrays)
data
required

An object to convert to an array.

outputArrayOfArrays
optional

A boolean to specify whether to return an array of arrays. Defaults to "false".

Return value

An array of objects or an array of arrays.

Example

Format data returned from a SQL query as an array, where each item represents one row of the query result.

formatDataAsArray({
  id: [2, 5],
  first_name: ["Rosemary", "Elizabeth"],
  last_name: ["Rogers", "Meets"],
});
[
  {
    "id": 2,
    "first_name": "Rosemary",
    "last_name": "Rogers"
  },
  {
    "id": 5,
    "first_name": "Elizabeth",
    "last_name": "Meets"
  }
]

formatDataAsObject()

Formats data as object.

Syntax

formatDataAsObject(data)
data
required

An array to convert to an object.

Return value

An object containing data.

Example

Return a Table component's changesetArray property, an array, as an object grouped by common keys.

formatDataAsObject([
  {
    "id": 2,
    "first_name": "Rosemary",
    "last_name": "Rogers",
  },
  {
    "id": 5,
    "first_name": "Elizabeth",
    "last_name": "Meets",
  },
]);
{
  id: [2, 5],
  first_name: ["Rosemary", "Elizabeth"],
  last_name: ["Rogers", "Meets"],
}