Object MethodCore Flow

Async.await(promise, timeoutMs?)

Waits for a promise (at most 60 s, 30 s by default) and returns a success flag and the value.

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

Async is a global table: call its functions with a dot (Async.<method>(...)), not a colon.

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

Required: promise. Optional: timeoutMs (omit to pass nil and use the runtime default). Returns two values: a success flag (boolean) and the resulting 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()
Async.defer(500, function() promise:resolve("ready") end)
local ok, value = Async.await(promise)

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

Simple

Wraps the base call with minimal flow control.

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

Practical Flow

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

Practical Flow
local ok, err = pcall(function()
  local promise = Async.promise()
  Async.defer(500, function() promise:resolve("ready") end)
  local ok, value = Async.await(promise)
end)

if not ok then
  print("API step failed: Async.await: " .. tostring(err))
  requestStop()
end

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

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