/sdk-typescript

Temporal TypeScript SDK

Primary LanguageTypeScriptOtherNOASSERTION

Temporal TypeScript SDK

CI NPM LICENSE

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 beta

Features

Mostly complete implementation of all components that make up a Temporal SDK - Worker, Client, Workflows, and Activities

Notably these features are missing:

  • Local activities
  • Side effects
  • Upsert search attributes
  • Test framework
  • Custom data converters

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.