resonate-async-await-engine-typescript

Resonate Async/Await Engine (TypeScript)

SDK version: This skill reflects @resonatehq/sdk v0.11.4 (current on npm). The async/await engine was introduced in v0.11.0.

Overview

The TypeScript SDK ships two execution engines:

Engine	Import path	Function style	Release
Generator engine	@resonatehq/sdk	function* / yield*	v0.10.x and earlier; still current
Async/await engine	@resonatehq/sdk/async	async function / await	v0.11.0+

Both engines connect to the same Resonate Server, share the same durable-promise substrate, and support the same patterns (fan-out, human-in-the-loop, saga, etc.). The async engine is opt-in — existing generator-engine code is unaffected.

For the generator engine, see resonate-basic-ephemeral-world-usage-typescript and resonate-basic-durable-world-usage-typescript.

---

When to use the async engine

• Writing new TypeScript workflows and prefer async/await over function*/yield*
• Integrating Resonate into a codebase that already uses async/await throughout
• Browser or edge environments: @resonatehq/sdk/async exports are browser-compatible

When to keep the generator engine

• Existing generator-engine code — there is no reason to migrate; the generator engine is fully supported
• You need ctx.detached() with the full bounded-replay pattern (async engine also has detach() but check the SDK changelog for your version)

---

Installation

npm install @resonatehq/[email protected]

Both engines are in the same package. The generator engine is the default export; the async engine is the /async sub-export.

---

Basic usage

import { Resonate } from "@resonatehq/sdk/async";

const resonate = new Resonate({ url: "http://localhost:8001" });

// Register an async function
resonate.register("greet", async (ctx, name: string) => {
  return `Hello, ${name}!`;
});

// Start a workflow — resonate.run(id, funcOrName, ...args) → Promise<ResonateHandle<T>>
const handle = await resonate.run("greet-001", "greet", "world");

// Await the result via the durable-promise subscription
const result = await handle.result();
// result === "Hello, world!"