@abtnode/queue 1.16.17-beta-6f0c7674 → 1.16.17-beta-703fb879

package/lib/index.js

@@ -12,6 +12,15 @@ const logger = require('./logger');
 const CANCELLED = '__CANCELLED__';
 const MIN_DELAY = process.env.NODE_ENV === 'test' ? 2 : 5;
 
+/**
+ * @typedef {{
+ *  entity: string,
+ *  action?: string,
+ *  blocklet: import('@abtnode/client').BlockletState,
+ *  context: {},
+ * }} Job
+ */
+
 /**
  *
  * @param {Object} config
@@ -57,6 +66,12 @@ module.exports = function createQueue({ file, store, onJob, options = {} }) {
     store = new NedbStore(file);
   }
 
+  /**
+   *
+   * @param {string} jobId
+   * @param {Job} job
+   * @returns
+   */
   const getJobId = (jobId, job) =>
     jobId || (typeof options.id === 'function' ? options.id(job) : uuid.v4()) || uuid.v4();
 
@@ -85,7 +100,7 @@ module.exports = function createQueue({ file, store, onJob, options = {} }) {
   /**
    * Push job to the queue, the old way of calling `push(job, jobId, persist)` will be deprecated
    * @param {object} params
-   * @param {object} params.job The data of the job
+   * @param {Job} params.job The data of the job
    * @param {string} params.jobId Optional, custom jobId
    * @param {boolean} params.persist [persist=true] Persisting the job to the database
    * @param {number} params.delay Optional, default with no delay, unit is second, for example: 10 will run after 10s

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.16.17-beta-6f0c7674",
+  "version": "1.16.17-beta-703fb879",
   "description": "",
   "main": "lib/index.js",
   "files": [
@@ -19,13 +19,13 @@
   "author": "wangshijun <wangshijun2010@gmail.com> (http://github.com/wangshijun)",
   "license": "Apache-2.0",
   "dependencies": {
-    "@abtnode/db": "1.16.17-beta-6f0c7674",
-    "@abtnode/util": "1.16.17-beta-6f0c7674",
+    "@abtnode/db": "1.16.17-beta-703fb879",
+    "@abtnode/util": "1.16.17-beta-703fb879",
     "debug": "^4.3.4",
     "fastq": "^1.13.0",
     "uuid": "^8.3.2"
   },
-  "gitHead": "8123f54b0f572c47f1ea704607aae113576c2a76",
+  "gitHead": "97d63c671d823076e58b994107e10866367edd5d",
   "devDependencies": {
     "jest": "^27.5.1"
   }