← Application timers

Timer.RequestId

luastra/timer

Timer.RequestId is the numeric acknowledgement returned by a timer control call. It confirms that the command crossed the SDK boundary, while the stable string timer ID identifies the later expiry delivered to app.handle.

Before you use it

Add luastra/timer to this module's dependencies in luastra.json, then import it with require("luastra/timer"). Declare timer.control in luastra.json and implement app.handle for timer events. The maximum delay is 60,000 ms.

How it fits

Timer types describe the options or acknowledgement identifier.

When to use it

Use Timer.RequestId when recording the acknowledgement returned by start, restart, or cancel. Do not wait for app.resolve: the timer expiry is delivered as a timer event to app.handle.

Fields or definition

ParameterType / valuesDescription
definitionnumberExact alias, union, or callable contract represented by Timer.RequestId.

What happens next

A checked timer option or acknowledgement annotation.

Failures and fixes

Missing timer.control, an invalid lowercase timer id, a delay outside 0..60000, or an oversized value fails before a timer event is scheduled. Treat late events as stale if the owning state has already changed.

Availability

Public-source alpha API in 0.5.0-alpha; exact background timing remains host-dependent.

Exact declaration

export type RequestId = number

Continue learning

Prerequisites

Timer.startTimer.restartTimer.cancel

Complete inventory

View all pages in Application timers
Next: Timer.StartOptions →