Global ObjectData and FilesSingleton Global

Array

Helpers for Lua lists: sort, filter, map, reduce, contains, length, reverse and join.

Documented for app version 1.0.51Updated:

Detailed Explanation

This section explains when to use the API, how to call it, and which structures it works best with in production flow.

How To Call It

Array is a singleton global table: call its functions with a dot (Array.<method>(...)).

When To Use It

In data flow, chaining JSON, Regex, Str, Map, and File steps to normalize intermediate values reduces error risk.

Parameters and Return

Array offers 8 methods; each method page lists its parameters and return value.

Best Combined With

When combined with Str, JSON, Regex, Array, Map, and File, data transformation becomes much more readable in script flow.

Example Usage

The snippet below is a starter pattern that can be applied directly in runtime flow.

local scores = Array.sort({ 3, 1, 2 })
local doubled = Array.map(scores, function(item) return item * 2 end)

Copyable Progressive Examples

From foundation to combined usage, each level is provided as a separate code block so you can copy the level you need and adapt it directly.

Foundation

Shows the shortest direct way to call the API.

Foundation
local scores = Array.sort({ 3, 1, 2 })
local doubled = Array.map(scores, function(item) return item * 2 end)

Simple

Wraps the base call with minimal flow control.

Simple
local scores = Array.sort({ 3, 1, 2 })
local doubled = Array.map(scores, function(item) return item * 2 end)

-- Continue with one focused method on the object.

Practical Flow

A practical pattern for real macros with pcall, logging, and guards.

Practical Flow
local scores = Array.sort({ 3, 1, 2 })
local doubled = Array.map(scores, function(item) return item * 2 end)
local note = "Array overview loaded"
print(note)

Detailed

This level packages the API into a reusable helper with error reporting.

Detailed
-- In data flow, chaining JSON, Regex, Str, Map, and File steps to normalize intermediate values reduces error risk.
local function run_array_step()
  local scores = Array.sort({ 3, 1, 2 })
  local doubled = Array.map(scores, function(item) return item * 2 end)
end

local ok, err = pcall(run_array_step)
if not ok then
  toast("Step failed")
  print(err)
end

Combined

Combines the API with related structures to form a more realistic workflow.

Combined
local scores = Array.sort({ 3, 1, 2 })
local doubled = Array.map(scores, function(item) return item * 2 end)
local raw = File.read("macro.log")
local normalized = Str.trim(raw)
print(normalized)