document watchStuckJobs

behrad · behrad · commit f00d4eb8c08e · 2015-03-23T01:18:19.000+04:30
diff --git a/lib/kue.js b/lib/kue.js
@@ -172,6 +172,14 @@ Queue.prototype.promote = function (ms, l) {
     }, ms);
 };
 
+/**
+ * Runs a LUA script to diff inactive jobs ZSET cardinality
+ * and helper pop LIST length each `ms` milliseconds and syncs helper LIST.
+ *
+ * @param {Number} ms interval for periodical script runs
+ * @api public
+ */
+
 Queue.prototype.watchStuckJobs = function (ms) {
     var client = this.client
         , ms = ms || 1000;
