Global ObjectDate and Time

Stopwatch

Stopwatch is used for date, duration, and timing operations.

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

Stopwatch 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. Stopwatch is used for date, duration, and timing operations.

When To Use It

For time flow, combine DateTime, TimeSpan, and Stopwatch with logging, timeout control, and performance measurement. 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

A strong combination is to measure with Stopwatch, log with DateTime, and compare durations with TimeSpan.

Example Usage

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

lua

-- Stopwatch:start
local result = Stopwatch:start({})
-- 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

-- Stopwatch:start
local result = Stopwatch:start({})
-- Use the result in your script flow

Simple

Wraps the base call with minimal flow control.

Simple

lua

-- Stopwatch:start
local result = Stopwatch:start({})
-- Use the result in your script flow

-- Continue with one focused method on the object.

Practical Flow

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

Practical Flow

lua

-- Stopwatch:start
local result = Stopwatch:start({})
-- Use the result in your script flow
local note = "Stopwatch overview loaded"
print(note)

Detailed

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

Detailed

lua

-- For time flow, combine DateTime, TimeSpan, and Stopwatch with logging, timeout control, and performance measurement.
local function run_stopwatch_step()
  -- Stopwatch:start
  local result = Stopwatch:start({})
  -- Use the result in your script flow
end

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

local watch = Stopwatch.startNew()
-- Stopwatch:start
local result = Stopwatch:start({})
-- Use the result in your script flow
local elapsed = watch:elapsedMilliseconds()
print("Elapsed: " .. tostring(elapsed))