Restate Typescript SDK

Restate is a system for easily building resilient applications using distributed durable async/await. This repository contains the Restate SDK for writing services in Node.js / Typescript.

Restate applications are composed of durably executed, stateful RPC handlers that can run either as part of long-running processes, or as FaaS (AWS Lambda).

import * as restate from "@restatedev/restate-sdk";

const greeter = restate.service({
    name: "greeter",
    handlers: {
        greet: async (ctx: restate.Context, name: string) => {
            return `Hello ${name}!`;
        },
    },
});

restate.serve({ services: [greeter], port: 9080 });
Copy

Community

• 🤗️ Join our online community for help, sharing feedback and talking to the community.
• 📖 Check out our documentation to get quickly started!
• 📣 Follow us on Twitter for staying up to date.
• 🙋 Create a GitHub issue for requesting a new feature or reporting a problem.
• 🏠 Visit our GitHub org for exploring other repositories.

Using the SDK

Prerequisites:

• NodeJS >= v20.19 or Bun or Deno
• npm CLI >= 9.6.7

To use this SDK, add the dependency to your project:

npm install @restatedev/restate-sdk
Copy

For brand-new projects, we recommend using the Restate Node Template:

npx -y @restatedev/create-app@latest
Copy

Check the Quickstart for more info.

Versions

This library follows Semantic Versioning.

The compatibility with Restate is described in the following table:

⁽¹⁾ Note the new options in service/object/workflow constructors, together with some of the new options in the handlers too, work only from Restate 1.4 onward. Check the in-code documentation for more details.

⁽²⁾ Note the new options.retryPolicy work only from Restate 1.5 onward. Check the in-code documentation for more details.

⁽³⁾ Warning SDK versions <= 1.4 are deprecated, and cannot be registered anymore. Check the Restate 1.5 release notes for more info.

Contributing

We’re excited if you join the Restate community and start contributing! Whether it is feature requests, bug reports, ideas & feedback or PRs, we appreciate any and all contributions. We know that your time is precious and, therefore, deeply value any effort to contribute!

For more info about developing the SDK, check the development guide.