Hatchet TypeScript SDK

This is the official TypeScript SDK for Hatchet, a distributed, fault-tolerant task queue. The SDK provides a type-safe way to integrate Hatchet's task scheduling and workflow orchestration capabilities into your TypeScript/JavaScript applications.

Installation

Install the SDK using npm:

``bash
npm install @hatchet-dev/typescript-sdk
`

Using yarn:

`bash
yarn add @hatchet-dev/typescript-sdk
`

Using pnpm:

`bash
pnpm add @hatchet-dev/typescript-sdk
`

Quick Start

For examples of how to use the Hatchet TypeScript SDK, including worker setup and task execution, please see our official documentation.

Features

- 📝 Type Safety: Full TypeScript support with type inference for workflow inputs and outputs
- 🔄 Workflow Orchestration: Define complex workflows with dependencies and parallel execution
- 🔁 Automatic Retries: Configure retry policies for handling transient failures
- 📊 Observability: Track workflow progress and monitor execution metrics
- ⏰ Scheduling: Schedule workflows to run at specific times or on a recurring basis
- 🔄 Event-Driven: Trigger workflows based on events in your system

Documentation

For detailed documentation, examples, and best practices, visit:
- Hatchet Documentation
- Examples

Development

We use pnpm as our package manager. To get started with development:

1. Install dependencies:
`bash
pnpm install
`

2. Build the SDK:
`bash
pnpm build
`

3. Run tests:
`bash
pnpm test
``

Contributing

We welcome contributions! Please check out our contributing guidelines and join our Discord community for discussions and support.

License

This SDK is released under the MIT License. See LICENSE for details.