bullmq 5.76.9 → 5.76.10

package/dist/cjs/classes/async-fifo-queue.js

@@ -63,6 +63,13 @@ class AsyncFifoQueue {
         this.pending = new Set();
         this.newPromise();
     }
+    /**
+     * Adds a promise to the queue. When it resolves, its value is enqueued
+     * and, if a consumer is waiting via {@link fetch}, the next pending
+     * promise is resolved with the value.
+     *
+     * @param promise - The asynchronous operation to add to the queue.
+     */
     add(promise) {
         this.pending.add(promise);
         promise
@@ -82,15 +89,38 @@ class AsyncFifoQueue {
             this.rejectPromise(err);
         });
     }
+    /**
+     * Waits for all currently pending promises to settle.
+     *
+     * @returns A promise that resolves once every in-flight promise has resolved.
+     */
     async waitAll() {
         await Promise.all(this.pending);
     }
+    /**
+     * Returns the total number of items currently tracked by the queue,
+     * including both pending (in-flight) promises and resolved items that
+     * have not yet been fetched.
+     *
+     * @returns The sum of pending and queued items.
+     */
     numTotal() {
         return this.pending.size + this.queue.length;
     }
+    /**
+     * Returns the number of promises that are still pending (in-flight).
+     *
+     * @returns The number of unresolved promises currently in the queue.
+     */
     numPending() {
         return this.pending.size;
     }
+    /**
+     * Returns the number of items that have already resolved but have not
+     * yet been fetched by a consumer.
+     *
+     * @returns The number of resolved items waiting to be consumed.
+     */
     numQueued() {
         return this.queue.length;
     }
@@ -111,6 +141,14 @@ class AsyncFifoQueue {
     async wait() {
         return this.nextPromise;
     }
+    /**
+     * Fetches the next resolved item from the queue in FIFO order. If no
+     * items are currently resolved but pending promises exist, it waits
+     * until the next one resolves.
+     *
+     * @returns The next resolved value, or `undefined` if there are no
+     * pending or queued items.
+     */
     async fetch() {
         var _a;
         if (this.pending.size === 0 && this.queue.length === 0) {

package/dist/cjs/classes/flow-producer.js

@@ -336,9 +336,10 @@ class FlowProducer extends events_1.EventEmitter {
      * Helper factory method that creates a queue-like object
      * required to create jobs in any queue.
      *
-     * @param node -
-     * @param queueKeys -
-     * @returns
+     * @param node - The flow node containing the queue name and other job options.
+     * @param queueKeys - The queue keys helper used to resolve key names.
+     * @param prefix - The Redis key prefix used for the queue.
+     * @returns A queue-like object with the client, keys, and options needed to create jobs.
      */
     queueFromNode(node, queueKeys, prefix) {
         return {

package/dist/cjs/classes/job.js

@@ -207,9 +207,15 @@ class Job {
         if (json.parentKey) {
             job.parentKey = json.parentKey;
         }
+        else {
+            job.parentKey = undefined;
+        }
         if (json.parent) {
             job.parent = JSON.parse(json.parent);
         }
+        else {
+            job.parent = undefined;
+        }
         if (json.pb) {
             job.processedBy = json.pb;
         }

package/dist/cjs/classes/queue-base.js

@@ -83,8 +83,8 @@ class QueueBase extends events_1.EventEmitter {
      * Emits an event. Normally used by subclasses to emit events.
      *
      * @param event - The emitted event.
-     * @param args -
-     * @returns
+     * @param args - The arguments to pass to the event listeners.
+     * @returns True if the event had listeners, false otherwise.
      */
     emit(event, ...args) {
         try {
@@ -152,8 +152,8 @@ class QueueBase extends events_1.EventEmitter {
      * @param operation - operation name (such as add, process, etc)
      * @param destination - destination name (normally the queue name)
      * @param callback - code to wrap with telemetry
-     * @param srcPropagationMetadata -
-     * @returns
+     * @param srcPropagationMetadata - The source propagation metadata for telemetry context.
+     * @returns The result of the callback function.
      */
     trace(spanKind, operation, destination, callback, srcPropagationMetadata) {
         return (0, utils_1.trace)(this.opts.telemetry, spanKind, this.name, operation, destination, callback, srcPropagationMetadata);

package/dist/cjs/classes/queue.js

@@ -631,7 +631,7 @@ class Queue extends queue_getters_1.QueueGetters {
     /**
      * Trim the event stream to an approximately maxLength.
      *
-     * @param maxLength -
+     * @param maxLength - The approximate maximum length, or target length, of the event stream.
      */
     async trimEvents(maxLength) {
         return this.trace(enums_1.SpanKind.INTERNAL, 'trimEvents', this.name, async (span) => {