Syntax

$await[name]

Parameters

Parameter	Description
name	Required, exactly one argument. Trimmed. The name of an $async block already started.

Return value

The text written by the block (empty if it wrote nothing).

Behavior

• A name that matches no started block raises Unknown async block "name". The block must have been started (reached by the script) before $await.
• If the block failed, its error is raised at $await. This is where $try can catch it. An error nobody awaited surfaces when the script ends.
• A block cannot wait for itself (An async block cannot await itself.) nor in a circle (Async blocks wait for each other.).
• The wait is bounded by the time budget of the command (15 minutes) and counts in the step limit of the script.
• Awaiting the same block several times returns the same text.
• Not to be confused with $awaitFunc, which stores a record and never suspends the script.

Example

$async[a]
  first
$endAsync
$try
  Result: $await[a]
$catch
  The block failed: $error
$endTry