@midwayjs/bull 3.20.0 → 3.20.3

package/dist/framework.d.ts

@@ -4,6 +4,10 @@ import { Job, JobOptions, QueueOptions } from 'bull';
 import Bull = require('bull');
 export declare class BullQueue extends Bull implements IQueue<Job> {
     constructor(queueName: string, queueOptions: QueueOptions);
+    addJobToQueue(data: any, options?: JobOptions): Promise<Job>;
+    /**
+     * @deprecated use addJobToQueue instead
+     */
     runJob(data: any, options?: JobOptions): Promise<Job>;
     getQueueName(): string;
 }
@@ -24,6 +28,10 @@ export declare class BullFramework extends BaseFramework<Application, Context, a
     ensureQueue(name: string, queueOptions?: QueueOptions): BullQueue;
     getQueueList(): BullQueue[];
     addProcessor(processor: new (...args: any[]) => IProcessor, queueName: string | BullQueue, concurrency?: number): Promise<void>;
+    addJobToQueue(queueName: string, jobData: any, options?: JobOptions): Promise<Job | undefined>;
+    /**
+     * @deprecated use addJob instead
+     */
     runJob(queueName: string, jobData: any, options?: JobOptions): Promise<Job | undefined>;
     getJob(queueName: string, jobName: string): Promise<Job>;
 }

package/dist/framework.js

@@ -17,6 +17,12 @@ class BullQueue extends Bull {
     constructor(queueName, queueOptions) {
         super(queueName, queueOptions);
     }
+    async addJobToQueue(data, options) {
+        return this.add(data || {}, options);
+    }
+    /**
+     * @deprecated use addJobToQueue instead
+     */
     async runJob(data, options) {
         return this.add(data || {}, options);
     }
@@ -64,7 +70,7 @@ let BullFramework = class BullFramework extends core_1.BaseFramework {
             }
             await this.addProcessor(mod, options.queueName, options.concurrency);
             if ((_c = options.jobOptions) === null || _c === void 0 ? void 0 : _c.repeat) {
-                await this.runJob(options.queueName, {}, options.jobOptions);
+                await this.addJobToQueue(options.queueName, {}, options.jobOptions);
             }
         }
     }
@@ -124,12 +130,18 @@ let BullFramework = class BullFramework extends core_1.BaseFramework {
             }
         });
     }
-    async runJob(queueName, jobData, options) {
+    async addJobToQueue(queueName, jobData, options) {
         const queue = this.queueMap.get(queueName);
         if (queue) {
-            return await queue.runJob(jobData, options);
+            return await queue.addJobToQueue(jobData, options);
         }
     }
+    /**
+     * @deprecated use addJob instead
+     */
+    async runJob(queueName, jobData, options) {
+        return this.addJobToQueue(queueName, jobData, options);
+    }
     async getJob(queueName, jobName) {
         const queue = this.queueMap.get(queueName);
         if (queue) {

package/dist/interface.d.ts

@@ -4,11 +4,19 @@ export interface IProcessor {
     execute(data: any): any;
 }
 export interface IQueue<Job> {
+    /**
+     * @deprecated use addJobToQueue instead
+     */
     runJob(data: Record<string, any>, options?: unknown): Promise<Job>;
+    addJobToQueue(data: Record<string, any>, options?: unknown): Promise<Job>;
     getJob(name: string): Promise<Job>;
     getQueueName(): string;
 }
 export interface IQueueManager<Queue extends IQueue<Job>, Job> {
+    addJobToQueue(queueName: string, jobData: any, options?: unknown): Promise<Job | undefined>;
+    /**
+     * @deprecated use addJobToQueue instead
+     */
     runJob(queueName: string, jobData: any, options?: unknown): Promise<Job | undefined>;
     getJob(queueName: string, jobName: string): Promise<Job>;
     createQueue(queueName: string, queueOptions?: unknown): Queue;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/bull",
-  "version": "3.20.0",
+  "version": "3.20.3",
   "description": "midway component for bull",
   "main": "dist/index.js",
   "typings": "index.d.ts",
@@ -24,8 +24,8 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/core": "^3.20.0",
-    "@midwayjs/mock": "^3.20.0"
+    "@midwayjs/core": "^3.20.3",
+    "@midwayjs/mock": "^3.20.3"
   },
   "dependencies": {
     "bull": "4.16.5"
@@ -33,5 +33,5 @@
   "engines": {
     "node": ">=12"
   },
-  "gitHead": "5bf838ec6054f6e1e983664b0456a975db795932"
+  "gitHead": "a0918e46838e220fd000997796dbc8d669d28746"
 }