@cinnabun/queue 0.0.1 → 0.0.6

package/README.md

@@ -0,0 +1,81 @@
+# @cinnabun/queue
+
+Job queue module for Cinnabun. Background jobs with Redis or in-memory adapters.
+
+## Installation
+
+```bash
+bun add @cinnabun/queue
+```
+
+## Quick Start
+
+### 1. Configure the module
+
+```typescript
+import { CinnabunApp, CinnabunFactory } from "@cinnabun/core";
+import { QueueModule, QueuePlugin, MemoryAdapter } from "@cinnabun/queue";
+
+@CinnabunApp({
+  port: 3000,
+  scanPaths: [],
+  imports: [
+    QueueModule.forRoot({
+      adapter: MemoryAdapter,
+    }),
+  ],
+  plugins: [new QueuePlugin()],
+})
+class App {}
+
+CinnabunFactory.run(App);
+```
+
+### 2. Define jobs and processors
+
+```typescript
+import { Processor, Job } from "@cinnabun/queue";
+
+@Processor("email")
+class EmailProcessor {
+  @Job("welcome")
+  async sendWelcome(data: { userId: string; email: string }) {
+    // Send welcome email
+  }
+}
+```
+
+### 3. Enqueue jobs
+
+```typescript
+import { QueueService } from "@cinnabun/queue";
+
+@RestController("/api")
+class UserController {
+  constructor(private queue: QueueService) {}
+
+  @PostMapping("/users")
+  async create(@Body() body: CreateUserDto) {
+    const user = await this.userService.create(body);
+    await this.queue.add("email", "welcome", { userId: user.id, email: user.email });
+    return user;
+  }
+}
+```
+
+### 4. Run the worker
+
+```bash
+bun run cinnabun worker
+# or
+bun run node_modules/@cinnabun/queue/dist/worker-bootstrap.js
+```
+
+## Adapters
+
+- **MemoryAdapter** — In-memory (development)
+- **RedisAdapter** — Redis-backed (production)
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cinnabun/queue",
-  "version": "0.0.1",
+  "version": "0.0.6",
   "description": "Job queue system for Cinnabun with Redis and in-memory adapters",
   "type": "module",
   "main": "dist/index.js",