bullmq 3.5.4 → 3.5.5

package/dist/esm/interfaces/minimal-job.d.ts

@@ -0,0 +1,111 @@
+import { JobsOptions, JobJsonSandbox } from '../types';
+import { JobJson } from './job-json';
+import { ParentKeys } from './parent';
+export type BulkJobOptions = Omit<JobsOptions, 'repeat'>;
+export interface MoveToWaitingChildrenOpts {
+    child?: {
+        id: string;
+        queue: string;
+    };
+}
+export interface DependenciesOpts {
+    processed?: {
+        cursor?: number;
+        count?: number;
+    };
+    unprocessed?: {
+        cursor?: number;
+        count?: number;
+    };
+}
+/**
+ * MinimalJob
+ */
+export interface MinimalJob<DataType = any, ReturnType = any, NameType extends string = string> {
+    /**
+     * The name of the Job
+     */
+    name: NameType;
+    /**
+     * The payload for this job.
+     */
+    data: DataType;
+    /**
+     * The options object for this job.
+     */
+    opts: JobsOptions;
+    id?: string;
+    /**
+     * The progress a job has performed so far.
+     * @defaultValue 0
+     */
+    progress: number | object;
+    /**
+     * The value returned by the processor when processing this job.
+     * @defaultValue null
+     */
+    returnvalue: ReturnType;
+    /**
+     * Stacktrace for the error (for failed jobs).
+     * @defaultValue null
+     */
+    stacktrace: string[];
+    /**
+     * An amount of milliseconds to wait until this job can be processed.
+     * @defaultValue 0
+     */
+    delay: number;
+    /**
+     * Timestamp when the job was created (unless overridden with job options).
+     */
+    timestamp: number;
+    /**
+     * Number of attempts after the job has failed.
+     * @defaultValue 0
+     */
+    attemptsMade: number;
+    /**
+     * Reason for failing.
+     */
+    failedReason: string;
+    /**
+     * Timestamp for when the job finished (completed or failed).
+     */
+    finishedOn?: number;
+    /**
+     * Timestamp for when the job was processed.
+     */
+    processedOn?: number;
+    /**
+     * Fully qualified key (including the queue prefix) pointing to the parent of this job.
+     */
+    parentKey?: string;
+    /**
+     * Object that contains parentId (id) and parent queueKey.
+     */
+    parent?: ParentKeys;
+    /**
+     * Base repeat job key.
+     */
+    repeatJobKey?: string;
+    /**
+     * Prepares a job to be serialized for storage in Redis.
+     * @returns
+     */
+    asJSON(): JobJson;
+    /**
+     * Prepares a job to be passed to Sandbox.
+     * @returns
+     */
+    asJSONSandbox(): JobJsonSandbox;
+    get queueName(): string;
+    /**
+     * @returns the prefix that is used.
+     */
+    get prefix(): string;
+    /**
+     * @returns it includes the prefix, the namespace separator :, and queue name.
+     * @see https://www.gnu.org/software/gawk/manual/html_node/Qualified-Names.html
+     */
+    get queueQualifiedName(): string;
+}

package/dist/esm/interfaces/minimal-job.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=minimal-job.js.map

package/dist/esm/interfaces/minimal-job.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"minimal-job.js","sourceRoot":"","sources":["../../../src/interfaces/minimal-job.ts"],"names":[],"mappings":""}

package/dist/esm/interfaces/parent.d.ts

@@ -13,3 +13,8 @@ export interface ParentKeys {
     id: string;
     queueKey: string;
 }
+export type ParentOpts = {
+    waitChildrenKey?: string;
+    parentDependenciesKey?: string;
+    parentKey?: string;
+};

package/dist/esm/types/backoff-strategy.d.ts

@@ -1,2 +1,2 @@
-import { Job } from '../classes/job';
-export type BackoffStrategy = (attemptsMade?: number, type?: string, err?: Error, job?: Job) => Promise<number> | number;
+import { MinimalJob } from '../interfaces/minimal-job';
+export type BackoffStrategy = (attemptsMade?: number, type?: string, err?: Error, job?: MinimalJob) => Promise<number> | number;

package/dist/esm/types/index.d.ts

@@ -1,5 +1,6 @@
 export * from './backoff-strategy';
 export * from './finished-status';
+export * from './minimal-queue';
 export * from './job-json-sandbox';
 export * from './job-options';
 export * from './job-type';

package/dist/esm/types/index.js

@@ -1,5 +1,6 @@
 export * from './backoff-strategy';
 export * from './finished-status';
+export * from './minimal-queue';
 export * from './job-json-sandbox';
 export * from './job-options';
 export * from './job-type';

package/dist/esm/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC"}

package/dist/esm/types/minimal-queue.d.ts

@@ -0,0 +1,2 @@
+import { QueueBase } from '../classes/queue-base';
+export type MinimalQueue = Pick<QueueBase, 'name' | 'client' | 'toKey' | 'keys' | 'opts' | 'closing' | 'waitUntilReady' | 'removeListener' | 'emit' | 'on' | 'redisVersion'>;

package/dist/esm/types/minimal-queue.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=minimal-queue.js.map

package/dist/esm/types/minimal-queue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"minimal-queue.js","sourceRoot":"","sources":["../../../src/types/minimal-queue.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bullmq",
-  "version": "3.5.4",
+  "version": "3.5.5",
   "description": "Queue for messages and jobs based on Redis",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
@@ -44,6 +44,7 @@
     "test": "ts-mocha -p tsconfig-cjs.json --config ./.mocharc.js",
     "test:watch": "ts-mocha -p tsconfig-cjs.json --paths 'tests/test_*.ts' -w --watch-extensions ts",
     "tsc": "tsc",
+    "circular:references": "madge --circular --extensions ts ./src",
     "tsc:all": "tsc && tsc -p tsconfig-cjs.json"
   },
   "dependencies": {
@@ -93,6 +94,7 @@
     "husky": "^8.0.1",
     "istanbul": "^0.4.5",
     "lint-staged": "13.0.3",
+    "madge": "^5.0.1",
     "mocha": "^10.0.0",
     "mocha-lcov-reporter": "^1.3.0",
     "moment": "^2.29.4",