Skip to main content

TypeScript SDK developer guide

Build Temporal Applications with the TypeScript SDK.

This guide provides a comprehensive overview of the structures, primitives, and features used in Temporal Application development.

Core application

Use the essential components of a Temporal Application (Workflows, Activities, and Workers) to build and run a Temporal application.

Temporal Client

Connect to a Temporal Service and start a Workflow Execution.

Testing

Set up the testing suite and test Workflows and Activities.

Failure detection

Explore how your application can detect failures using timeouts and automatically attempt to mitigate them with retries.

Workflow message passing

Send messages to and read the state of Workflow Executions.

Interrupt a Workflow feature guide

Interrupt a Workflow Execution with a Cancel or Terminate action.

Asynchronous Activity Completion

Complete Activities asynchronously.

Versioning

Change Workflow Definitions without causing non-deterministic behavior in current long-running Workflows.

Observability

Configure and use the Temporal Observability APIs.

Debugging

Explore various ways to debug your application.

Schedules

Run Workflows on a schedule and delay the start of a Workflow.

Data encryption

Use compression, encryption, and other data handling by implementing custom converters and codecs.

Durable Timers

Use Timers to make a Workflow Execution pause or "sleep" for seconds, minutes, days, months, or years.

Child Workflows

Explore how to spawn a Child Workflow Execution and handle Child Workflow Events.

Continue-As-New

Continue the Workflow Execution with a new Workflow Execution using the same Workflow ID.

Interceptors

Manage inbound and outbound SDK calls, enhance tracing, and add authorization to your Workflows and Activities.