Object MethodData and Files

File:read(path)

Reads and returns data from File.

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:read performs one focused job in script flow and can be chained cleanly with other API steps. Reads and returns data from File.

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

path define the purpose of the call; preparing them in clearly named variables before execution makes production debugging easier. This API reads or produces data; storing the returned value in a variable and reusing it in later steps is the safest approach.

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:read
local result = File:read("macro.log")
-- Use the result in your script flow

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:read
local result = File:read("macro.log")
-- Use the result in your script flow

Simple

Wraps the base call with minimal flow control.

Simple

lua

local stepOk = true
-- File:read
local result = File:read("macro.log")
-- Use the result in your script flow
if stepOk then
  wait(200)
end

Practical Flow

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

Practical Flow

lua

local ok, result = pcall(function()
  -- File:read
  local result = File:read("macro.log")
  -- Use the result in your script flow
end)

if not ok then
  print("API step failed: File:read")
  requestStop()
end

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_read_step()
  -- File:read
  local result = File:read("macro.log")
  -- Use the result in your script flow
end

local ok, err = pcall(run_read_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:read
local result = File:read("macro.log")
-- Use the result in your script flow
local raw = File.read("macro.log")
local normalized = Str.trim(raw)
print(normalized)