@koala42/redis-highway 0.1.3 → 0.1.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 KOALA42
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,6 +1,16 @@
 # @koala42/redis-highway
 
-High performance Redis stream-based queue for Node.js.
+High performance Redis stream-based queue for Node.js. Supports Redis single instances and Valkey single instances
+
+## Missing features ATM
+- Better gracefull shutdown handling
+- In worker process functions expose more than just data: T like job id and current status
+- Option to customize/enable/disable metrics
+- Enable custom logger for workers and producers instead of console.logs
+
+
+## Roadmap
+- Support redis cluster, that is probably possible only for job payloads and DLQ, since the stream is only one
 
 ## Installation
 
@@ -21,7 +31,7 @@ const producer = new Producer(redis, 'my-stream');
 
 // Send job
 await producer.push(
-  JSON.stringify({ hello: 'world' }), 
+  JSON.stringify({ hello: 'world' }), // Message serialization is not done automatically
   ['group-A', 'group-B'] // Target specific consumer groups
 );
 ```
@@ -32,8 +42,8 @@ await producer.push(
 import { Redis } from 'ioredis';
 import { Worker } from '@koala42/redis-highway';
 
-class MyWorker extends Worker {
-  async process(data: any) {
+class MyWorker extends Worker<T> {
+  async process(data: T) {
     console.log('Processing:', data);
     // throw new Error('fail'); // Automatic retry/DLQ logic
   }
@@ -56,8 +66,59 @@ const metrics = new Metrics(redis, 'my-stream');
 const payload = await metrics.getPrometheusMetrics(['group-A']);
 ```
 
-## Features
+## Usage with NestJS
+
+```typescript
+
+// Producer
+@Injectable()
+export class EntryService {
+  privater readonly producer: Producer;
+  
+  constructor(){
+    this.producer = new Producer(
+      new Redis(...), // Or reuse existing ioredis connection
+      'my-stream'
+    )
+  }
+  
+  public async sth(): Promise<void>{
+    await producer.push(
+      JSON.stringify({ hello: 'world' }), // Message serialization is not done automatically
+      ['group-A', 'group-B'] // Target specific consumer groups
+    );
+  }
+}
+
 
+// Processor
+@Injectable()
+export class ProcessorService extends Worker<T> implements OnModuleInit, OnModuleDestroy {
+  constructor(){
+    super(
+      new Redis(...), // or reuse existing redis conn
+      'group-A',
+      'my-stream',
+      50 // concurrency
+    )
+  }
+  
+  async onModuleInit(): Promise<void>{
+    await this.start()
+  }
+  
+  onModuleDestroy(){
+    this.stop()
+  }
+  
+  async process(data: T): Promise<void>{
+    console.log("Processing job", JSON.stringify(data))
+  }
+}
+````
+
+## Features
+- **Lightweight**: Uses light Lua scripts and pipelines wherever possible, making it highly concurrents for inserts and for processing as well, because of the reduced I/O load compared to BullMQ
 - **Granular Retries**: If one group fails, only that group retries.
 - **DLQ**: Dead Letter Queue support after max retries.
 - **Metrics**: Throughput, Waiting, DLQ, Prometheus export.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@koala42/redis-highway",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "High performance redis queue",
   "license": "MIT",
   "author": {
@@ -37,4 +37,4 @@
     "typescript": "^5.9.3",
     "vitest": "^4.0.16"
   }
-}
+}