Global ObjectCore FlowSingleton Global

AsyncPromise

The result object Async.promise() creates: complete it with resolve or reject and wait for it with await.

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

AsyncPromise is not a global name; call its methods with a colon on a promise created with Async.promise() (nil when the promise limit is reached).

When To Use It

Core flow APIs are usually the backbone of larger scenarios; keep them anchored to clear checkpoints and readable variables.

Parameters and Return

AsyncPromise offers 7 methods; each method page lists its parameters and return value.

Best Combined With

Using this API with logging, error handling, and next-step control produces much more professional results than calling it in isolation.

Example Usage

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

local promise = Async.promise()
if promise then
  Async.defer(500, function() promise:resolve("ready") end)
  local ok, value = promise:await(2000)
end

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
local promise = Async.promise()
if promise then
  Async.defer(500, function() promise:resolve("ready") end)
  local ok, value = promise:await(2000)
end

Simple

Wraps the base call with minimal flow control.

Simple
local promise = Async.promise()
if promise then
  Async.defer(500, function() promise:resolve("ready") end)
  local ok, value = promise:await(2000)
end

-- Continue with one focused method on the object.

Practical Flow

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

Practical Flow
local promise = Async.promise()
if promise then
  Async.defer(500, function() promise:resolve("ready") end)
  local ok, value = promise:await(2000)
end
local note = "AsyncPromise overview loaded"
print(note)

Detailed

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

Detailed
-- Core flow APIs are usually the backbone of larger scenarios; keep them anchored to clear checkpoints and readable variables.
local function run_asyncpromise_step()
  local promise = Async.promise()
  if promise then
    Async.defer(500, function() promise:resolve("ready") end)
    local ok, value = promise:await(2000)
  end
end

local ok, err = pcall(run_asyncpromise_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
local promise = Async.promise()
if promise then
  Async.defer(500, function() promise:resolve("ready") end)
  local ok, value = promise:await(2000)
end
wait(200)
print("Combined with logging and flow control")