Queue

@veloxts/queue provides background job processing.

Installation

pnpm add @veloxts/queue

Define Jobs

import { defineJob } from '@veloxts/queue';
import { z } from '@veloxts/velox';

export const SendWelcomeEmail = defineJob({
  name: 'send-welcome-email',
  schema: z.object({
    userId: z.string(),
    email: z.string().email(),
  }),
  handler: async ({ data, progress }) => {
    await progress(50);
    await sendEmail(data.email, 'Welcome!');
    await progress(100);
  },
});

Dispatch Jobs

import { dispatch } from '@veloxts/queue';

await dispatch(SendWelcomeEmail, {
  userId: '123',
  email: 'user@example.com',
});

Drivers

Sync (Development)

queuePlugin({
  driver: 'sync', // Runs immediately
})

BullMQ (Production)

queuePlugin({
  driver: 'bullmq',
  config: { url: process.env.REDIS_URL },
})

Job Options

await dispatch(SendWelcomeEmail, data, {
  delay: 60_000,       // Delay 1 minute
  attempts: 3,         // Retry 3 times
  backoff: {
    type: 'exponential',
    delay: 1000,
  },
});

Next Steps

• Mail - Email sending
• Scheduler - Scheduled tasks