@bymax-one/nest-queue 1.2.5 → 1.2.6

package/CHANGELOG.md

@@ -11,6 +11,30 @@ versioning follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ---
 
+## [1.2.6] — 2026-10-31
+
+No action required: behaviour, the public API, the types and the peer ranges are unchanged.
+Measured with `diff -r` of a fresh build against the unpacked 1.2.5 tarball, `dist/` is identical;
+the package otherwise changes in `README.md`, this file and the version in `package.json`.
+
+### Documentation
+
+- **The README Quick Start now shows where `EmailService` and the processor are registered.** The
+  `AppModule` snippet imports an `EmailModule` that lists both as providers, so a reader who copies
+  the snippets in order ends with a module graph that resolves, instead of a service no module provides
+  and a processor module the root never imports.
+
+### Tests
+
+- **The README Quick Start now runs.** A spec boots a Nest application context from the module
+  options, the `QueueService` enqueue and the `@Processor` / `@Process` handler copied from the
+  README (handler body aside), with BullMQ and ioredis replaced by in-memory doubles, and asserts
+  the job the service enqueues is the job the decorated handler receives. The snippet gate only
+  compiles the README; this executes it, so a wrong argument shape or an unresolved dependency fails
+  a test.
+
+---
+
 ## [1.2.5] — 2026-10-31
 
 No action required: behaviour, the public API, the types and the peer ranges are unchanged.
@@ -678,7 +702,8 @@ v6 peer range.
 
 ---
 
-[Unreleased]: https://github.com/bymaxone/nest-queue/compare/v1.2.5...HEAD
+[Unreleased]: https://github.com/bymaxone/nest-queue/compare/v1.2.6...HEAD
+[1.2.6]: https://github.com/bymaxone/nest-queue/compare/v1.2.5...v1.2.6
 [1.2.5]: https://github.com/bymaxone/nest-queue/compare/v1.2.4...v1.2.5
 [1.2.4]: https://github.com/bymaxone/nest-queue/compare/v1.2.3...v1.2.4
 [1.2.3]: https://github.com/bymaxone/nest-queue/compare/v1.2.2...v1.2.3

package/README.md

@@ -168,6 +168,7 @@ Wire the module in your root `AppModule`:
 ```typescript
 import { Module } from '@nestjs/common'
 import { BymaxQueueModule } from '@bymax-one/nest-queue'
+import { EmailModule } from './email.module'
 
 @Module({
   imports: [
@@ -175,6 +176,7 @@ import { BymaxQueueModule } from '@bymax-one/nest-queue'
       connection: { url: process.env.REDIS_URL ?? 'redis://localhost:6379' },
       isGlobal: true,
     }),
+    EmailModule,
   ],
 })
 export class AppModule {}
@@ -213,14 +215,16 @@ export class EmailProcessor {
 }
 ```
 
-Register the processor in your module alongside `BymaxQueueModule`:
+Register the service and the processor in a feature module that `AppModule` imports, like the `EmailModule`
+imported above. `isGlobal: true` above makes `QueueService` injectable there without importing `BymaxQueueModule` again:
 
 ```typescript
 import { Module } from '@nestjs/common'
 import { EmailProcessor } from './email.processor'
+import { EmailService } from './email.service'
 
 @Module({
-  providers: [EmailProcessor],
+  providers: [EmailService, EmailProcessor],
 })
 export class EmailModule {}
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bymax-one/nest-queue",
-  "version": "1.2.5",
+  "version": "1.2.6",
   "description": "NestJS dynamic module wrapping BullMQ — typed jobs, flows, job schedulers, deduplication, OpenTelemetry, graceful shutdown",
   "author": "Bymax One <support@bymax.one>",
   "license": "MIT",