Resonate TypeScript SDK

About this component

The Resonate TypeScript SDK enables developers to build reliable and scalable cloud applications across a wide variety of use cases.

• How to contribute to this SDK
• Evaluate Resonate for your next project
• Example application library
• Join the Discord
• Subscribe to the Blog
• Follow on Twitter
• Follow on LinkedIn
• Subscribe on YouTube

Quickstart

1. Install the Resonate Server & CLI

brew install resonatehq/tap/resonate
Copy

2. Install the Resonate SDK

npm install @resonatehq/sdk
Copy

3. Write your first Resonate Function

A countdown as a loop. Simple, but the function can run for minutes, hours, or days, despite restarts.

import { Resonate, type Context } from "@resonatehq/sdk";

function* countdown(context: Context, count: number, delay: number) {
  for (let i = count; i > 0; i--) {
    // Run a function, persist its result
    yield* context.run((context: Context) => console.log(`Countdown: ${i}`));
    // Sleep
    yield* context.sleep(delay * 1000);
  }
  console.log("Done!");
}
// Instantiate Resonate
const resonate = new Resonate({ url: "http://localhost:8001" });
// Register the function
resonate.register(countdown);
Copy

Clone a working example repo

4. Start the server

resonate dev
Copy

5. Start the worker

npx ts-node countdown.ts
Copy

6. Run the function

Run the function with execution ID countdown.1:

resonate invoke countdown.1 --func countdown --arg 5 --arg 60
Copy

Result

You will see the countdown in the terminal

npx ts-node countdown.ts
Countdown: 5
Countdown: 4
Countdown: 3
Countdown: 2
Countdown: 1
Done!
Copy

What to try

After starting the function, inspect the current state of the execution using the resonate tree command. The tree command visualizes the call graph of the function execution as a graph of durable promises.

resonate tree countdown.1
Copy

Now try killing the worker mid-countdown and restarting. The countdown picks up right where it left off without missing a beat.