Temporal TypeScript SDK
Temporal is a microservice orchestration platform which enables developers to build scalable applications without sacrificing productivity or reliability. Temporal server executes units of application logic—Workflows—in a resilient manner that automatically handles intermittent failures and retries failed operations.
Temporal is a mature technology—it's a fork of Uber's Cadence. Temporal is being developed by Temporal Technologies, a startup by the creators of Cadence.
Documentation
Check out the Getting started page for a quick overview.
The documentation is divided into several sections:
You can improve it by sending pull requests to this repository (for the API reference) or to the documentation repository.
This SDK is in alpha
Features
Mostly complete implementation of all components that make up a Temporal SDK - Worker, Client, Workflows, and Activities
- General
- Cancellation
- Interceptors
- Telemetry
- Workflows
- Scheduling timers
- Scheduling (non-local) Activities
- Child and external Workflows
- Cancelling timers and Activities
- Signals
- Queries
- Versioning
- Activities (complete)
- Client (complete)
- Workflow client
- Service client (for administration)
- Worker (mostly complete)
- Basic logging and tracing capabilities
- Sticky Workflow execution
Notably these features are missing:
- Local activities
- Side effects
- Search attributes
- Windows support
NOTE: The API is considered unstable and may change at any time.
While in alpha we are gathering feedback from developers about the usability and ergonomics of the API.
To provide feedback please open an issue and feel free to
talk to us on the #typescript-sdk community slack channel or post on our discourse support forum.
Installation
See the getting started guide for setting up a project on your laptop.
Contributing
Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to the SDK.