Quickstart | Get started with Resonate
Install the Resonate Server & CLI
Shell
brew install resonatehq/tap/resonate
Install the Resonate SDK
- TypeScript
- Python
Shell
npm install @resonatehq/sdk
Shell
pip install resonate-sdk
Write your first Resonate Function
A countdown as a loop. Simple, but the function can run for minutes, hours, or days, despite restarts.
- TypeScript
- Python
countdown.ts
TypeScriptimport { 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);
countdown.py
Pythonfrom resonate import Resonate, Context
from threading import Event
def countdown(ctx: Context, count: int, delay: int):
for i in range(count, 0, -1):
# Run a function, persist its result
yield ctx.run(ntfy, i)
# Sleep
yield ctx.sleep(delay)
print("Done!")
def ntfy(_: Context, i: int):
print(f"Countdown: {i}")
# Instantiate Resonate
resonate = Resonate.remote()
# Register the function
resonate.register(countdown)
resonate.start() # Start Resonate threads
Event().wait() # Keep the main thread alive
Start the server
Shell
resonate dev
Start the worker
- TypeScript
- Python
Shell
npx ts-node countdown.ts
Shell
python countdown.py
Run the function
Run the function with execution ID countdown.1:
Shell
resonate invoke countdown.1 --func countdown --arg 5 --arg 60
Result
You will see the countdown in the terminal
- TypeScript
- Python
Shell
npx ts-node countdown.ts
Countdown: 5
Countdown: 4
Countdown: 3
Countdown: 2
Countdown: 1
Done!
Shell
python countdown.py
Countdown: 5
Countdown: 4
Countdown: 3
Countdown: 2
Countdown: 1
Done!
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.
Shell
resonate tree countdown.1
Now try killing the worker mid-countdown and restarting. The countdown picks up right where it left off without missing a beat.