Vorsteh Queue

Vorsteh Queue is a powerful and ORM-agnostic queue engine designed specifically for PostgreSQL 12 and above. This tool simplifies the management of background jobs, scheduled tasks, and recurring processes, enabling developers to focus on building applications instead of handling complex job processing logic.

Key Features

• Type-safe: Fully supports TypeScript with generic job payloads, ensuring safer code and better developer experience.
• Multiple Adapters: Works seamlessly with Drizzle ORM (PostgreSQL), Prisma ORM (PostgreSQL), and in-memory implementations for flexible usage.
• Priority Queues: Enables a numeric priority system where lower numbers correspond to higher priority, allowing efficient job scheduling.
• Delayed Jobs: Schedule jobs for future execution with ease.
• Recurring Jobs: Supports cron expressions and interval-based repetitions for handling scheduled tasks effectively.
• UTC-first Timezone Support: Ensures reliable timezone management with automatic UTC storage, eliminating timezone-related issues.
• Progress Tracking: Offers real-time job progress updates for better monitoring and management of long-running tasks.
• Event System: Listen to job lifecycle events to implement custom logic as jobs change state.
• Graceful Shutdown: Ensures clean termination of job processing, enhancing application stability.

Repository Structure

The project is organized into a clear directory structure, with dedicated packages for core functionality and various adapters.

Quick Start

To utilize Vorsteh Queue, ensure your environment meets the following requirements:

• Node.js 20+
• ESM Only: This package is designed for ES modules only.

Basic Usage Example

Here's a basic example of how to implement Vorsteh Queue with the Drizzle ORM:

import { drizzle } from "drizzle-orm/node-postgres";
import { Pool } from "pg";
import { PostgresQueueAdapter } from "@vorsteh-queue/adapter-drizzle";
import { Queue } from "@vorsteh-queue/core";

const pool = new Pool({ connectionString: "postgresql://..." });
const db = drizzle(pool);
const queue = new Queue(new PostgresQueueAdapter(db), { name: "my-queue" });

queue.register("send-email", async (job) => {
  // Email sending logic
});

await queue.add("send-email", { to: "user@example.com", subject: "Welcome!" });
queue.start();

Additional examples are available in the examples directory that demonstrate advanced usage and features.