feat(bull-adapter): 🚀 Updated README to reflect new API changes

This commit is contained in:
Lilith 2026-01-13 09:12:21 -08:00
parent 79a93f17c3
commit 3a2c693082

View file

@ -1,4 +1,4 @@
# @queue/bull-adapter
# @lilith/queue/bull-adapter
Bull/BullMQ queue adapter with NestJS module support. Provides a unified interface for queue operations with full TypeScript support.
@ -15,7 +15,7 @@ Bull/BullMQ queue adapter with NestJS module support. Provides a unified interfa
## Installation
```bash
pnpm add @queue/bull-adapter bullmq ioredis
pnpm add @lilith/queue bullmq ioredis
```
## Quick Start
@ -26,7 +26,7 @@ pnpm add @queue/bull-adapter bullmq ioredis
```typescript
import { Module } from '@nestjs/common';
import { QueueModule } from '@queue/bull-adapter';
import { QueueModule } from '@lilith/queue/bull-adapter';
@Module({
imports: [
@ -51,7 +51,7 @@ export class AppModule {}
```typescript
import { Module } from '@nestjs/common';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { QueueModule } from '@queue/bull-adapter';
import { QueueModule } from '@lilith/queue/bull-adapter';
@Module({
imports: [
@ -77,7 +77,7 @@ export class AppModule {}
```typescript
import { Injectable } from '@nestjs/common';
import { BaseQueueService, JobOptions } from '@queue/bull-adapter';
import { BaseQueueService, JobOptions } from '@lilith/queue/bull-adapter';
interface EmailPayload {
to: string;
@ -294,7 +294,7 @@ Create a worker to process jobs:
```typescript
import { Worker, Job } from 'bullmq';
import { JobData } from '@queue/bull-adapter';
import { JobData } from '@lilith/queue/bull-adapter';
const worker = new Worker(
'main',
@ -337,7 +337,7 @@ import {
DEFAULT_JOB_TIMEOUT, // 300000 (5 minutes)
DEFAULT_CONCURRENCY, // 1
DEFAULT_REDIS_CONFIG, // { host: 'localhost', port: 6379 }
} from '@queue/bull-adapter';
} from '@lilith/queue/bull-adapter';
```
## TypeScript Support