debuggerpk / sdk-node

Temporal NodeJS SDK

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Temporal NodeJS 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, a fork of Uber's Cadence. Temporal is being developed by Temporal Technologies, a startup by the creators of Cadence.

Learn how to use Temporal on the docs site.

This SDK is in alpha stage

Features

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

  • Workflows
    • Scheduling timers
    • Scheduling (non-local) Activities
    • Cancelling timers and Activities
    • Signals
  • Activities
    • Heartbeats
    • Cancellation
    • Context
  • Client
    • Workflow client
    • Service client (for administration)
  • Worker
    • Basic logging and tracing capabilities
    • Polling on a single non-sticky task queue

Notably these features are missing:

  • WF History pagination (only short Workflows are supported ATM)
  • Sticky queues (meaning Workflows are not cached and are replayed from the beginning each time a new event comes in)
  • Telemetry
  • Workflow versioning
  • Workflow cancellation
  • Query support
  • Local activities
  • Side effects
  • 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 community slack channel.

Installation

See the getting started guide for setting up a project on your laptop.

Documentation

You can find the project's documentation as well as general documentation for Temporal on our docs site.

The API reference for this SDK can be found here.

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.

About

Temporal NodeJS SDK

License:Other


Languages

Language:TypeScript 81.3%Language:Rust 8.9%Language:JavaScript 8.0%Language:CSS 0.9%Language:C++ 0.7%Language:Python 0.2%