Global ObjectData and FilesSingleton Global

Str

String helpers. Positions are 0-based like Java strings: Str.indexOf returns -1 when nothing is found and Str.substring(source, start, end) excludes end.

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

Str is a singleton global table: call its functions with a dot (Str.<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

Str offers 25 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 name = Str.trim("  Macro Handler  ")
if Str.startsWith(name, "Macro") then
  print(Str.toUpperCase(name))
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 name = Str.trim("  Macro Handler  ")
if Str.startsWith(name, "Macro") then
  print(Str.toUpperCase(name))
end

Simple

Wraps the base call with minimal flow control.

Simple
local name = Str.trim("  Macro Handler  ")
if Str.startsWith(name, "Macro") then
  print(Str.toUpperCase(name))
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 name = Str.trim("  Macro Handler  ")
if Str.startsWith(name, "Macro") then
  print(Str.toUpperCase(name))
end
local note = "Str 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_str_step()
  local name = Str.trim("  Macro Handler  ")
  if Str.startsWith(name, "Macro") then
    print(Str.toUpperCase(name))
  end
end

local ok, err = pcall(run_str_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 name = Str.trim("  Macro Handler  ")
if Str.startsWith(name, "Macro") then
  print(Str.toUpperCase(name))
end
local raw = File.read("macro.log")
local normalized = Str.trim(raw)
print(normalized)