Global ObjectData and FilesSingleton Global

Clipboard

Copies text to the clipboard and reads the clipboard text.

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

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

Clipboard offers 4 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.

Clipboard.copy("Macro Handler")
local text = Clipboard.paste()

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
Clipboard.copy("Macro Handler")
local text = Clipboard.paste()

Simple

Wraps the base call with minimal flow control.

Simple
Clipboard.copy("Macro Handler")
local text = Clipboard.paste()

-- Continue with one focused method on the object.

Practical Flow

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

Practical Flow
Clipboard.copy("Macro Handler")
local text = Clipboard.paste()
local note = "Clipboard 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_clipboard_step()
  Clipboard.copy("Macro Handler")
  local text = Clipboard.paste()
end

local ok, err = pcall(run_clipboard_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
Clipboard.copy("Macro Handler")
local text = Clipboard.paste()
local raw = File.read("macro.log")
local normalized = Str.trim(raw)
print(normalized)