Global ObjectData and Files

File

File is part of the Macro Handler API surface.

Detailed Explanation

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

What It Does

File is the main entry point for this object family. Use it to understand the responsibility of the namespace before diving into the methods below it. File is part of the Macro Handler API surface.

When To Use It

In data flow, chaining JSON, Regex, Str, Map, and File steps to normalize intermediate values reduces error risk. This API becomes most valuable in multi-step chained scenarios.

Parameters and Return

This entry does not require mandatory parameters. This entry is a namespace or helper object overview; the real flow is built with the methods listed below it.

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.

lua

File.write("run.log", "Started")
local txt = File.read("run.log")

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

lua

File.write("run.log", "Started")
local txt = File.read("run.log")

Simple

Wraps the base call with minimal flow control.

Simple

lua

File.write("run.log", "Started")
local txt = File.read("run.log")

-- Continue with one focused method on the object.

Practical Flow

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

Practical Flow

lua

File.write("run.log", "Started")
local txt = File.read("run.log")
local note = "File overview loaded"
print(note)

Detailed

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

Detailed

lua

-- In data flow, chaining JSON, Regex, Str, Map, and File steps to normalize intermediate values reduces error risk.
local function run_file_step()
  File.write("run.log", "Started")
  local txt = File.read("run.log")
end

local ok, err = pcall(run_file_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

lua

File.write("run.log", "Started")
local txt = File.read("run.log")
local raw = File.read("macro.log")
local normalized = Str.trim(raw)
print(normalized)