# resonatehq_sdk
> Resonate TypeScript SDK
Latest version **0.1.0** (published 2024-02-24) · Apache-2.0 license · 0 weekly downloads
## Install
```sh
npm install resonatehq_sdk
pnpm add resonatehq_sdk
yarn add resonatehq_sdk
bun add resonatehq_sdk
```
## Health
**Score 30/100 (F)** — status: abandoned.
Positive: has types; esm support; no vulnerabilities; high quality score.
Warnings: low downloads; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.1.0 |
| Published | 2024-02-24 |
| First published | 2024-02-24 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 17.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | parweb |
## Links
- npm: https://www.npmjs.com/package/resonatehq_sdk
- npm.io page: https://npm.io/package/resonatehq_sdk
## Dependencies (2)
- [cron-parser](https://npm.io/package/cron-parser.md) ^4.9.0
- [@opentelemetry/api](https://npm.io/package/@opentelemetry/api.md) ^1.7.0
## Recent versions
- 0.1.0 (latest) — 2024-02-24
## README
> Resonate is in the **Design Phase**
>
> Our code base is constantly evolving as we are exploring Resonate's programming model. If you are passionate about a dead simple developer experience, join us on this journey of discovery and share your thoughts.
>
> [Join our slack](https://resonatehqcommunity.slack.com)
Resonate TypeScript SDK
[](https://github.com/resonatehq/resonate-sdk-ts/actions/workflows/cicd.yaml)
[](https://codecov.io/gh/resonatehq/resonate-sdk-ts)
[](https://opensource.org/licenses/Apache-2.0)
An SDK for writing simple and elegant distributed async await applications.
## Why Resonate?
Resonate offers a programming model that allows you to build distributed applications using an intuitive paradigm you already know — async await.
## What is Distributed Async Await?
Distributed Async Await extends the async await programming model beyond the boundaries of a single process and makes distributed computing a first-class citizen.
## Features
Available now:
- retries
- recovery
- schedules
- tracing
- logging
- local promise store
- remote promise store
Coming soon:
- rate limiting
- metrics
Let us know [features](https://github.com/resonatehq/resonate-sdk-ts/issues) you would like Resonate to support.
## Install
```console
npm install -g ts-node
npm install @resonatehq/sdk
npm install express @types/express
```
## What's New
Schedules! You can now invoke a function on a recurring schedule. Please note, this feature is experimental and bugs are expected. If encountered please [let us know](https://github.com/resonatehq/resonate-sdk-ts/issues/new).
```ts
import { Resonate, Context } from "@resonatehq/sdk";
const resonate = new Resonate();
resonate.schedule("everyMinute", "* * * * *", (ctx: Context) => {
console.log("every minute", Date.now());
});
resonate.schedule("everyHour", "0 * * * *", (ctx: Context) => {
console.log("every hour", Date.now());
});
resonate.start();
```
## Getting Started
```ts
import { Resonate, Context } from "@resonatehq/sdk";
import express, { Request, Response } from "express";
type User = {
id: number;
};
type Song = {
id: number;
price: number;
};
type Status = {
charged: boolean;
granted: boolean;
};
async function purchase(ctx: Context, user: User, song: Song): Promise {
const charged = await ctx.run(charge, user, song);
const granted = await ctx.run(access, user, song);
return { charged, granted };
}
async function charge(ctx: Context, user: User, song: Song): Promise {
console.log(`Charged user:${user.id} $${song.price}.`);
return true;
}
async function access(ctx: Context, user: User, song: Song): Promise {
console.log(`Granted user:${user.id} access to song:${song.id}.`);
return true;
}
// Initialize Resonate app
const resonate = new Resonate();
resonate.register("purchase", purchase);
// Initialize Express app
const app = express();
app.use(express.json())
app.post("/purchase", async (req: Request, res: Response) => {
const user = { id: req.body?.user ?? 1 };
const song = { id: req.body?.song ?? 1, price: 1.99 };
// id uniquely identifies the purchase
const id = `purchase-${user.id}-${song.id}`;
try {
res.send(await resonate.run("purchase", id, user, song));
} catch (err) {
res.status(500).send("Could not purchase song");
}
});
app.listen(3000, () => {
console.log("Listening on port 3000");
});
```
Start the server.
```console
ts-node app.ts
```
And call the endpoint providing a user and song id.
```console
curl \
-X POST \
-H 'Content-Type: application/json' \
-d '{"user": 1, "song": 1}' \
http://localhost:3000/purchase
```
See our [docs](https://docs.resonatehq.io) for more detailed information.
## Development
```console
npm install
npm run lint
npm test
```
## Contributing
See our [contribution guidelines](CONTRIBUTING.md).
## License
The Resonate TypeScript SDK is available under the [Apache 2.0 License](LICENSE).
---
_Source: https://npm.io/package/resonatehq_sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._