TypeScript SDK developer guide

Install and get started

You can find detailed installation instructions for the TypeScript SDK in the Quickstart.

There's also a short walkthrough of how to use the Temporal primitives (Activities, Workflows, and Workers) to build and run a Temporal application to get you up and running.

Once your local Temporal Service is set up, continue building with the following resources:

• Develop a Workflow
• Develop an Activity
• Start an Activity execution
• Run Worker processes

Workflows

• Workflow basics
• Child Workflows
• Continue-As-New
• Message passing
• Cancellation
• Cancellation scopes
• Timeouts
• Enriching the UI
• Schedules
• Timers
• Versioning

Activities

• Activity basics
• Activity execution
• Timeouts
• Asynchronous Activity
• Benign exceptions

Workers

• Worker processes
• Interceptors
• Observability

Temporal Client

• Temporal Client
• Namespaces

Temporal Nexus

• Service handlers

Best practices

• Testing
• Debugging
• Converters and encryption
• Entity pattern

Vercel AI SDK Integration

Integrate the Vercel AI SDK with Temporal to build durable AI agents and AI-powered applications.

• Vercel AI SDK Integration

Temporal TypeScript Technical Resources

• TypeScript SDK Quickstart - Setup Guide
• TypeScript API Documentation
• TypeScript SDK Code Samples
• TypeScript SDK GitHub
• Temporal 101 in TypeScript Free Course

Get Connected with the Temporal TypeScript Community

• Temporal TypeScript Community Slack
• TypeScript SDK Forum

Linting and types in TypeScript

If you started your project with @temporalio/create, you already have our recommended TypeScript and ESLint configurations.

If you incrementally added Temporal to an existing app, we do recommend setting up linting and types because they help catch bugs well before you ship them to production, and they improve your development feedback loop. Take a look at our recommended .eslintrc file and tweak to suit your needs.