@zudojs/queue 1.4.0 → 1.4.1

package/README.md

@@ -57,6 +57,35 @@ console.log(await queue.getStats());
 await queue.close();
 ```
 
+## Dead-letter store
+
+Each queue keeps the most recent 1000 dead-lettered jobs in a store of its own,
+cleared by `close()`. To choose the cap, or to keep the jobs after the queue
+closes, pass a store as `deadLetterStore`. No type annotation is needed, for
+an untyped store or one typed for the queue's payload.
+
+```typescript
+import {
+  createInMemoryDeadLetterStore,
+  createInMemoryQueue,
+  createQueueName,
+} from "@zudojs/queue";
+
+// Keep only the 50 most recent failures.
+const store = createInMemoryDeadLetterStore({ maxEntries: 50 });
+const broken = createInMemoryQueue(createQueueName("broken"), {
+  deadLetterStore: store,
+});
+
+// A store typed for the payload, so its entries read as DeadLetterJob<Email>.
+const failedEmails = createInMemoryDeadLetterStore<Email>();
+const emails = createInMemoryQueue<Email>(createQueueName("emails"), {
+  deadLetterStore: failedEmails,
+});
+```
+
+`close()` leaves a store you passed in alone; its contents are yours.
+
 ## Features
 
 - In-memory queue for development and testing

package/dist/inMemoryQueue/inMemoryQueue.core.js

@@ -81,6 +81,9 @@ export class InMemoryQueue {
             this.emitter.setLogger(this.options.logger);
         }
         this.ownsDeadLetterStore = this.options.deadLetterStore === undefined;
+        // A caller's store is typed `DeadLetterStore<unknown>` (see
+        // `QueueOptions.deadLetterStore`); this queue only ever adds its own
+        // `TData` jobs to it, so it is read back as a store of `TData`.
         this.deadLetterStore =
             this.options.deadLetterStore ??
                 createInMemoryDeadLetterStore({

package/dist/queue/queue.type.d.ts

@@ -63,8 +63,15 @@ export interface QueueOptions {
      * emitter, reachable as `queue.events`.
      */
     readonly eventEmitter?: QueueEventEmitter;
-    /** Store that receives jobs which exhausted their attempts. */
-    readonly deadLetterStore?: DeadLetterStore<never>;
+    /**
+     * Store that receives jobs which exhausted their attempts.
+     *
+     * Any store is accepted without an annotation: the untyped
+     * `createInMemoryDeadLetterStore()` and one typed for the queue's payload,
+     * `createInMemoryDeadLetterStore<TData>()`. (1.4.0 typed this
+     * `DeadLetterStore<never>`, which rejected both.)
+     */
+    readonly deadLetterStore?: DeadLetterStore<unknown>;
     /**
      * Whether `add()` rejects while the queue is paused.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zudojs/queue",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "description": "Background job and asynchronous task infrastructure with in-memory and adapter-based queue implementations.",
   "license": "MIT",
   "author": {
@@ -27,7 +27,7 @@
   "dependencies": {
     "@zudojs/errors": "1.3.0",
     "@zudojs/constants": "1.1.2",
-    "@zudojs/serialization": "1.2.0"
+    "@zudojs/serialization": "1.2.1"
   },
   "devDependencies": {
     "typescript": "7.0.2",