remove onJob references

Author: muniter

CLAUDE.md

@@ -10,7 +10,7 @@ This is `@muniter/queue`, a TypeScript queue system inspired by Yii2-Queue archi
 
 **@muniter/queue** is an event-driven job queue system that allows you to:
 - Define job types as TypeScript interfaces (not classes) for type safety
-- Register job handlers using simple `onJob()` callbacks
+- Register job handlers using type-safe `setHandlers()` method
 - Add jobs to queues with compile-time validation of payloads and options
 - Process jobs asynchronously with configurable workers
 - Switch between storage backends (File, Database, SQS) without changing job code
@@ -48,7 +48,7 @@ The CLI worker supports these arguments:
    - **DbQueue** (`src/drivers/db.ts`): Database-backed queue using DatabaseAdapter interface
    - **SqsQueue** (`src/drivers/sqs.ts`): Amazon SQS-backed queue
    - **FileQueue** (`src/drivers/file.ts`): File-based queue storing jobs as individual files with JSON index
-3. **Jobs**: Defined as TypeScript interfaces in a JobMap, with handlers registered via `onJob()` method
+3. **Jobs**: Defined as TypeScript interfaces in a JobMap, with handlers registered via `setHandlers()` method
 4. **Workers**: Long-running processes that consume and execute jobs
 5. **Serialization**: Pluggable serialization system for job payloads
 
@@ -76,7 +76,7 @@ The queue emits lifecycle events:
 ## Development Patterns
 
 ### Job Implementation
-Jobs are defined as TypeScript interfaces in a JobMap type, and handlers are registered using the `onJob()` method. The payload is serialized using JSON by default.
+Jobs are defined as TypeScript interfaces in a JobMap type, and handlers are registered using the `setHandlers()` method. The payload is serialized using JSON by default.
 
 ### Database Adapters
 When implementing DatabaseAdapter, you must provide:

README.md

@@ -37,17 +37,22 @@ interface MyJobs {
 
 const queue = new FileQueue<MyJobs>({ path: './queue-data' });
 
-// Register event-based handlers
-queue.onJob('send-email', async (payload) => {
-  // payload is automatically typed as { to: string; subject: string; body: string }
-  console.log(`Sending email to ${payload.to}: ${payload.subject}`);
-  await sendEmail(payload.to, payload.subject, payload.body);
-});
-
-queue.onJob('resize-image', async (payload) => {
-  // payload is automatically typed as { url: string; width: number; height: number }
-  console.log(`Resizing image ${payload.url} to ${payload.width}x${payload.height}`);
-  await resizeImage(payload.url, payload.width, payload.height);
+// Register type-safe handlers
+queue.setHandlers({
+  'send-email': async ({ payload }) => {
+    // payload is automatically typed as { to: string; subject: string; body: string }
+    console.log(`Sending email to ${payload.to}: ${payload.subject}`);
+    await sendEmail(payload.to, payload.subject, payload.body);
+  },
+  'resize-image': async ({ payload }) => {
+    // payload is automatically typed as { url: string; width: number; height: number }
+    console.log(`Resizing image ${payload.url} to ${payload.width}x${payload.height}`);
+    await resizeImage(payload.url, payload.width, payload.height);
+  },
+  'generate-report': async ({ payload }) => {
+    // Handle report generation
+    console.log(`Generating ${payload.type} report for ${payload.period}`);
+  }
 });
 ```
 
@@ -309,7 +314,7 @@ pnpm run queue:worker -- --timeout 10
 ### Queue Methods
 
 - `addJob<K>(name: K, request: { payload: JobMap[K], ...options }): Promise<string>` - Add job to queue
-- `onJob<K>(name: K, handler: (payload: JobMap[K]) => Promise<void>): this` - Register job handler
+- `setHandlers(handlers: JobHandlers<JobMap>): void` - Register all job handlers with type safety
 - `run(repeat?: boolean, timeout?: number): Promise<void>` - Start processing jobs
 - `status(id: string): Promise<JobStatus>` - Get job status
 
@@ -329,7 +334,7 @@ interface JobMap {
 }
 
 // Jobs are defined as TypeScript interfaces, not classes
-// Handlers are registered with queue.onJob()
+// Handlers are registered with queue.setHandlers()
 ```
 
 ## Testing

docs/design/plugin-architecture.md

@@ -390,8 +390,10 @@ const queue = new FileQueue<MyJobs>({
 });
 
 // Register job handlers
-queue.onJob('send-email', async (payload) => {
-  await emailService.send(payload);
+queue.setHandlers({
+  'send-email': async ({ payload }) => {
+    await emailService.send(payload);
+  }
 });
 
 // Simple run call - plugins are already configured

example-queue-project/src/email-queue.ts

@@ -1,4 +1,4 @@
-import { FileQueue, Queue } from "@muniter/queue";
+import { FileQueue } from "@muniter/queue";
 import { createSQSQueue } from "@muniter/queue/sqs";
 
 interface EmailJobs {
@@ -22,29 +22,30 @@ export const emailQueueSqs = createSQSQueue<EmailJobs>(
 export const emailQueue = emailQueueSqs;
 
 // Register job handlers for email queue
-emailQueue.onJob("welcome-email", async (payload) => {
-  const { to, name } = payload;
-  console.log(`Sending welcome email to ${to} (${name})`);
-  await new Promise((resolve) => setTimeout(resolve, 1000));
+emailQueue.setHandlers({
+  "welcome-email": async ({ payload }) => {
+    const { to, name } = payload;
+    console.log(`Sending welcome email to ${to} (${name})`);
+    await new Promise((resolve) => setTimeout(resolve, 1000));
 
-  if (Math.random() > 0.8) {
-    throw new Error("Email service temporarily unavailable");
-  }
-
-  console.log(`Welcome email sent successfully to ${to}`);
-});
+    if (Math.random() > 0.8) {
+      throw new Error("Email service temporarily unavailable");
+    }
 
-emailQueue.onJob("notification", async (payload) => {
-  const { to, subject, body } = payload;
-  console.log(`Sending notification email to ${to}: ${subject}`);
-  await new Promise((resolve) => setTimeout(resolve, 500));
-  emailQueue.addJob("welcome-email", {
-    payload: {
-      to: "javier@muniter.com",
-      name: "Javier",
-    },
-  });
-  console.log(`Notification sent successfully`);
+    console.log(`Welcome email sent successfully to ${to}`);
+  },
+  "notification": async ({ payload }, queue) => {
+    const { to, subject, body } = payload;
+    console.log(`Sending notification email to ${to}: ${subject}`);
+    await new Promise((resolve) => setTimeout(resolve, 500));
+    queue.addJob("welcome-email", {
+      payload: {
+        to: "javier@muniter.com",
+        name: "Javier",
+      },
+    });
+    console.log(`Notification sent successfully`);
+  }
 });
 
 emailQueue.on("beforeExec", (event) => {

example-queue-project/src/general-queue.ts

@@ -8,30 +8,31 @@ export interface GeneralJobs {
 export const generalQueue = createSQLiteQueue<GeneralJobs>('queue.db');
 
 // Register job handlers for general queue
-generalQueue.onJob('process-image', async (payload) => {
-    const { url, width, height } = payload;
-    console.log(`Processing image from ${url} to ${width}x${height}`);
-
-    const steps = ['Downloading', 'Resizing', 'Optimizing', 'Saving'];
-    for (const step of steps) {
-        console.log(`  - ${step}...`);
-        await new Promise(resolve => setTimeout(resolve, 800));
+generalQueue.setHandlers({
+    'process-image': async ({ payload }) => {
+        const { url, width, height } = payload;
+        console.log(`Processing image from ${url} to ${width}x${height}`);
+
+        const steps = ['Downloading', 'Resizing', 'Optimizing', 'Saving'];
+        for (const step of steps) {
+            console.log(`  - ${step}...`);
+            await new Promise(resolve => setTimeout(resolve, 800));
+        }
+
+        console.log(`Image processed successfully`);
+    },
+    'generate-report': async ({ payload }) => {
+        const { type, period } = payload;
+        console.log(`Generating ${type} report for ${period}`);
+
+        const steps = ['Fetching data', 'Processing', 'Formatting', 'Saving'];
+        for (const step of steps) {
+            console.log(`  - ${step}...`);
+            await new Promise(resolve => setTimeout(resolve, 600));
+        }
+
+        console.log(`Report generated: ${type} for ${period}`);
     }
-
-    console.log(`Image processed successfully`);
-})
-
-generalQueue.onJob('generate-report', async (payload) => {
-    const { type, period } = payload;
-    console.log(`Generating ${type} report for ${period}`);
-
-    const steps = ['Fetching data', 'Processing', 'Formatting', 'Saving'];
-    for (const step of steps) {
-        console.log(`  - ${step}...`);
-        await new Promise(resolve => setTimeout(resolve, 600));
-    }
-
-    console.log(`Report generated: ${type} for ${period}`);
 });
 
 // Add event listeners for both queues

example-queue-project/src/redis-queue.ts

@@ -9,18 +9,19 @@ interface EmailJobs {
 export const emailQueue = createRedisQueue<EmailJobs>('redis://localhost:6379');
 
 // Register job handlers
-emailQueue.onJob("welcome-email", async (payload) => {
-  const { to, name } = payload;
-  console.log(`[Redis] Sending welcome email to ${to} (${name})`);
-  await new Promise((resolve) => setTimeout(resolve, 1000));
-  console.log(`[Redis] Welcome email sent successfully to ${to}`);
-});
-
-emailQueue.onJob("notification", async (payload) => {
-  const { to, subject, body } = payload;
-  console.log(`[Redis] Sending notification email to ${to}: ${subject}`);
-  await new Promise((resolve) => setTimeout(resolve, 500));
-  console.log(`[Redis] Notification sent successfully`);
+emailQueue.setHandlers({
+  "welcome-email": async ({ payload }) => {
+    const { to, name } = payload;
+    console.log(`[Redis] Sending welcome email to ${to} (${name})`);
+    await new Promise((resolve) => setTimeout(resolve, 1000));
+    console.log(`[Redis] Welcome email sent successfully to ${to}`);
+  },
+  "notification": async ({ payload }) => {
+    const { to, subject, body } = payload;
+    console.log(`[Redis] Sending notification email to ${to}: ${subject}`);
+    await new Promise((resolve) => setTimeout(resolve, 500));
+    console.log(`[Redis] Notification sent successfully`);
+  }
 });
 
 // Event listeners

src/core/queue.ts

@@ -17,12 +17,19 @@ import type { QueuePlugin, QueueOptions } from '../interfaces/plugin.ts';
  * const queue = new FileQueue<MyJobs>({ path: './queue-data' });
  * 
  * // Register job handlers
- * queue.onJob('send-email', async (payload) => {
- *   await sendEmail(payload.to, payload.subject, payload.body);
+ * queue.setHandlers({
+ *   'send-email': async ({ payload }) => {
+ *     await sendEmail(payload.to, payload.subject, payload.body);
+ *   },
+ *   'resize-image': async ({ payload }) => {
+ *     await resizeImage(payload.url, payload.width, payload.height);
+ *   }
  * });
  * 
  * // Add jobs with type safety
- * await queue.addJob('send-email', { to: 'user@example.com', subject: 'Hello', body: 'World' });
+ * await queue.addJob('send-email', { 
+ *   payload: { to: 'user@example.com', subject: 'Hello', body: 'World' }
+ * });
  * 
  * // Start processing
  * await queue.run();