bullmq 1.58.0 → 1.59.0

package/dist/esm/classes/master.js

@@ -0,0 +1,35 @@
+import { toString } from 'lodash';
+import { ChildProcessor } from './child-processor';
+import { ParentCommand, ChildCommand } from '../interfaces';
+import { childSend } from '../utils';
+const childProcessor = new ChildProcessor();
+process.on('message', async (msg) => {
+    try {
+        switch (msg.cmd) {
+            case ChildCommand.Init:
+                await childProcessor.init(msg.value);
+                break;
+            case ChildCommand.Start:
+                await childProcessor.start(msg.job);
+                break;
+            case ChildCommand.Stop:
+                break;
+        }
+    }
+    catch (err) {
+        console.error('Error handling child message');
+    }
+});
+process.on('SIGTERM', () => childProcessor.waitForCurrentJobAndExit());
+process.on('SIGINT', () => childProcessor.waitForCurrentJobAndExit());
+process.on('uncaughtException', async (err) => {
+    if (!err.message) {
+        err = new Error(toString(err));
+    }
+    await childSend(process, {
+        cmd: ParentCommand.Failed,
+        value: err,
+    });
+    throw err;
+});
+//# sourceMappingURL=master.js.map

package/dist/esm/classes/master.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"master.js","sourceRoot":"","sources":["../../../src/classes/master.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAElC,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAErC,MAAM,cAAc,GAAG,IAAI,cAAc,EAAE,CAAC;AAE5C,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,KAAK,EAAC,GAAG,EAAC,EAAE;IAChC,IAAI;QACF,QAAQ,GAAG,CAAC,GAAmB,EAAE;YAC/B,KAAK,YAAY,CAAC,IAAI;gBACpB,MAAM,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBACrC,MAAM;YACR,KAAK,YAAY,CAAC,KAAK;gBACrB,MAAM,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBACpC,MAAM;YACR,KAAK,YAAY,CAAC,IAAI;gBACpB,MAAM;SACT;KACF;IAAC,OAAO,GAAG,EAAE;QACZ,OAAO,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC;KAC/C;AACH,CAAC,CAAC,CAAC;AAEH,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,wBAAwB,EAAE,CAAC,CAAC;AACvE,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,wBAAwB,EAAE,CAAC,CAAC;AAEtE,OAAO,CAAC,EAAE,CAAC,mBAAmB,EAAE,KAAK,EAAE,GAAU,EAAE,EAAE;IACnD,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE;QAChB,GAAG,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;KAChC;IACD,MAAM,SAAS,CAAC,OAAO,EAAE;QACvB,GAAG,EAAE,aAAa,CAAC,MAAM;QACzB,KAAK,EAAE,GAAG;KACX,CAAC,CAAC;IAEH,MAAM,GAAG,CAAC;AACZ,CAAC,CAAC,CAAC"}

package/dist/esm/classes/process-utils.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="node" />
+import { ChildProcess } from 'child_process';
+/**
+ * Sends a kill signal to a child resolving when the child has exited,
+ * resorting to SIGKILL if the given timeout is reached
+ */
+export declare function killAsync(child: ChildProcess, signal?: 'SIGTERM' | 'SIGKILL', timeoutMs?: number): Promise<void>;

package/dist/esm/classes/process-utils.js

@@ -0,0 +1,31 @@
+'use strict';
+function onExitOnce(child) {
+    return new Promise(resolve => {
+        child.once('exit', () => resolve());
+    });
+}
+function hasProcessExited(child) {
+    return !!(child.exitCode !== null || child.signalCode);
+}
+/**
+ * Sends a kill signal to a child resolving when the child has exited,
+ * resorting to SIGKILL if the given timeout is reached
+ */
+export async function killAsync(child, signal = 'SIGKILL', timeoutMs = undefined) {
+    if (hasProcessExited(child)) {
+        return;
+    }
+    const onExit = onExitOnce(child);
+    child.kill(signal);
+    if (timeoutMs === 0 || isFinite(timeoutMs)) {
+        const timeoutHandle = setTimeout(() => {
+            if (!hasProcessExited(child)) {
+                child.kill('SIGKILL');
+            }
+        }, timeoutMs);
+        await onExit;
+        clearTimeout(timeoutHandle);
+    }
+    await onExit;
+}
+//# sourceMappingURL=process-utils.js.map

package/dist/esm/classes/process-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"process-utils.js","sourceRoot":"","sources":["../../../src/classes/process-utils.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAIb,SAAS,UAAU,CAAC,KAAmB;IACrC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;QAC3B,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAmB;IAC3C,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,KAAK,IAAI,IAAI,KAAK,CAAC,UAAU,CAAC,CAAC;AACzD,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,KAAmB,EACnB,SAAgC,SAAS,EACzC,YAAoB,SAAS;IAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;QAC3B,OAAO;KACR;IAED,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IACjC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAEnB,IAAI,SAAS,KAAK,CAAC,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE;QAC1C,MAAM,aAAa,GAAG,UAAU,CAAC,GAAG,EAAE;YACpC,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE;gBAC5B,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aACvB;QACH,CAAC,EAAE,SAAS,CAAC,CAAC;QACd,MAAM,MAAM,CAAC;QACb,YAAY,CAAC,aAAa,CAAC,CAAC;KAC7B;IACD,MAAM,MAAM,CAAC;AACf,CAAC"}

package/dist/esm/classes/queue-base.d.ts

@@ -0,0 +1,22 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import { QueueBaseOptions, RedisClient } from '../interfaces';
+import { RedisConnection } from './redis-connection';
+import { KeysMap } from './queue-keys';
+export declare class QueueBase extends EventEmitter {
+    readonly name: string;
+    opts: QueueBaseOptions;
+    toKey: (type: string) => string;
+    keys: KeysMap;
+    closing: Promise<void>;
+    protected connection: RedisConnection;
+    constructor(name: string, opts?: QueueBaseOptions, Connection?: typeof RedisConnection);
+    get client(): Promise<RedisClient>;
+    get redisVersion(): string;
+    emit(event: string | symbol, ...args: any[]): boolean;
+    waitUntilReady(): Promise<RedisClient>;
+    protected base64Name(): string;
+    protected clientName(): string;
+    close(): Promise<void>;
+    disconnect(): Promise<void>;
+}

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

@@ -0,0 +1,62 @@
+import { EventEmitter } from 'events';
+import { RedisConnection } from './redis-connection';
+import { QueueKeys } from './queue-keys';
+export class QueueBase extends EventEmitter {
+    constructor(name, opts = {}, Connection = RedisConnection) {
+        super();
+        this.name = name;
+        this.opts = opts;
+        this.opts = Object.assign({ prefix: 'bull' }, opts);
+        if (!opts.connection) {
+            console.warn([
+                'BullMQ: DEPRECATION WARNING! Optional instantiation of Queue, Worker, QueueScheduler and QueueEvents',
+                'without providing explicitly a connection or connection options is deprecated. This behaviour will',
+                'be removed in the next major release',
+            ].join(' '));
+        }
+        this.connection = new Connection(opts.connection, opts.sharedConnection);
+        this.connection.on('error', this.emit.bind(this, 'error'));
+        const queueKeys = new QueueKeys(opts.prefix);
+        this.keys = queueKeys.getKeys(name);
+        this.toKey = (type) => queueKeys.toKey(name, type);
+    }
+    get client() {
+        return this.connection.client;
+    }
+    get redisVersion() {
+        return this.connection.redisVersion;
+    }
+    emit(event, ...args) {
+        try {
+            return super.emit(event, ...args);
+        }
+        catch (err) {
+            try {
+                return super.emit('error', err);
+            }
+            catch (err) {
+                // We give up if the error event also throws an exception.
+                console.error(err);
+            }
+        }
+    }
+    waitUntilReady() {
+        return this.client;
+    }
+    base64Name() {
+        return Buffer.from(this.name).toString('base64');
+    }
+    clientName() {
+        return this.opts.prefix + ':' + this.base64Name();
+    }
+    close() {
+        if (!this.closing) {
+            this.closing = this.connection.close();
+        }
+        return this.closing;
+    }
+    disconnect() {
+        return this.connection.disconnect();
+    }
+}
+//# sourceMappingURL=queue-base.js.map

package/dist/esm/classes/queue-base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queue-base.js","sourceRoot":"","sources":["../../../src/classes/queue-base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAW,SAAS,EAAE,MAAM,cAAc,CAAC;AAElD,MAAM,OAAO,SAAU,SAAQ,YAAY;IAOzC,YACkB,IAAY,EACrB,OAAyB,EAAE,EAClC,aAAqC,eAAe;QAEpD,KAAK,EAAE,CAAC;QAJQ,SAAI,GAAJ,IAAI,CAAQ;QACrB,SAAI,GAAJ,IAAI,CAAuB;QAKlC,IAAI,CAAC,IAAI,mBACP,MAAM,EAAE,MAAM,IACX,IAAI,CACR,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACpB,OAAO,CAAC,IAAI,CACV;gBACE,sGAAsG;gBACtG,oGAAoG;gBACpG,sCAAsC;aACvC,CAAC,IAAI,CAAC,GAAG,CAAC,CACZ,CAAC;SACH;QAED,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACzE,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QAE3D,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC7C,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,CAAC,KAAK,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC7D,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAChC,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;IACtC,CAAC;IAED,IAAI,CAAC,KAAsB,EAAE,GAAG,IAAW;QACzC,IAAI;YACF,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;SACnC;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI;gBACF,OAAO,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;aACjC;YAAC,OAAO,GAAG,EAAE;gBACZ,0DAA0D;gBAC1D,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;aACpB;SACF;IACH,CAAC;IAED,cAAc;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAES,UAAU;QAClB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;IAES,UAAU;QAClB,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;IACpD,CAAC;IAED,KAAK;QACH,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;SACxC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC;IACtC,CAAC;CACF"}

package/dist/esm/classes/queue-events.d.ts

@@ -0,0 +1,153 @@
+import { QueueEventsOptions } from '../interfaces';
+import { QueueBase } from './queue-base';
+import { RedisConnection } from './redis-connection';
+export interface QueueEventsListener {
+    /**
+     * Listen to 'active' event.
+     *
+     * This event is triggered when a job enters the 'active' state.
+     */
+    active: (args: {
+        jobId: string;
+        prev?: string;
+    }, id: string) => void;
+    /**
+     * Listen to 'added' event.
+     *
+     * This event is triggered when a job is created.
+     */
+    added: (args: {
+        jobId: string;
+        name: string;
+        data: string;
+        opts: string;
+    }, id: string) => void;
+    /**
+     * Listen to 'cleaned' event.
+     *
+     * This event is triggered when a cleaned method is triggered.
+     */
+    cleaned: (args: {
+        count: string;
+    }, id: string) => void;
+    /**
+     * Listen to 'completed' event.
+     *
+     * This event is triggered when a job has successfully completed.
+     */
+    completed: (args: {
+        jobId: string;
+        returnvalue: string;
+        prev?: string;
+    }, id: string) => void;
+    /**
+     * Listen to 'delayed' event.
+     *
+     * This event is triggered when a job is delayed.
+     */
+    delayed: (args: {
+        jobId: string;
+        delay: number;
+    }, id: string) => void;
+    /**
+     * Listen to 'drained' event.
+     *
+     * This event is triggered when the queue has drained the waiting list.
+     * Note that there could still be delayed jobs waiting their timers to expire
+     * and this event will still be triggered as long as the waiting list has emptied.
+     */
+    drained: (id: string) => void;
+    /**
+     * Listen to 'error' event.
+     *
+     * This event is triggered when an exception is thrown.
+     */
+    error: (args: Error) => void;
+    /**
+     * Listen to 'failed' event.
+     *
+     * This event is triggered when a job has thrown an exception.
+     */
+    failed: (args: {
+        jobId: string;
+        failedReason: string;
+        prev?: string;
+    }, id: string) => void;
+    /**
+     * Listen to 'paused' event.
+     *
+     * This event is triggered when a queue is paused.
+     */
+    paused: (args: {}, id: string) => void;
+    /**
+     * Listen to 'progress' event.
+     *
+     * This event is triggered when a job updates it progress, i.e. the
+     * Job##updateProgress() method is called. This is useful to notify
+     * progress or any other data from within a processor to the rest of the
+     * world.
+     */
+    progress: (args: {
+        jobId: string;
+        data: number | object;
+    }, id: string) => void;
+    /**
+     * Listen to 'removed' event.
+     *
+     * This event is triggered when a job has been manually
+     * removed from the queue.
+     */
+    removed: (args: {
+        jobId: string;
+    }, id: string) => void;
+    /**
+     * Listen to 'resumed' event.
+     *
+     * This event is triggered when a queue is resumed.
+     */
+    resumed: (args: {}, id: string) => void;
+    /**
+     * Listen to 'stalled' event.
+     *
+     * This event is triggered when a job has been moved from 'active' back
+     * to 'waiting'/'failed' due to the processor not being able to renew
+     * the lock on the said job.
+     */
+    stalled: (args: {
+        jobId: string;
+    }, id: string) => void;
+    /**
+     * Listen to 'waiting' event.
+     *
+     * This event is triggered when a job enters the 'waiting' state.
+     */
+    waiting: (args: {
+        jobId: string;
+    }, id: string) => void;
+    /**
+     * Listen to 'waiting-children' event.
+     *
+     * This event is triggered when a job enters the 'waiting-children' state.
+     */
+    'waiting-children': (args: {
+        jobId: string;
+    }, id: string) => void;
+}
+/**
+ * The QueueEvents class is used for listening to the global events
+ * emitted by a given queue.
+ *
+ * This class requires a dedicated redis connection.
+ *
+ */
+export declare class QueueEvents extends QueueBase {
+    private running;
+    emit<U extends keyof QueueEventsListener>(event: U, ...args: Parameters<QueueEventsListener[U]>): boolean;
+    off<U extends keyof QueueEventsListener>(eventName: U, listener: QueueEventsListener[U]): this;
+    on<U extends keyof QueueEventsListener>(event: U, listener: QueueEventsListener[U]): this;
+    once<U extends keyof QueueEventsListener>(event: U, listener: QueueEventsListener[U]): this;
+    constructor(name: string, { connection, autorun, ...opts }?: QueueEventsOptions, Connection?: typeof RedisConnection);
+    run(): Promise<void>;
+    private consumeEvents;
+    close(): Promise<void>;
+}

package/dist/esm/classes/queue-events.js

@@ -0,0 +1,108 @@
+import { __rest } from "tslib";
+import { array2obj, delay, isNotConnectionError, isRedisInstance, } from '../utils';
+import { DELAY_TIME_5 } from '../utils';
+import { QueueBase } from './queue-base';
+/**
+ * The QueueEvents class is used for listening to the global events
+ * emitted by a given queue.
+ *
+ * This class requires a dedicated redis connection.
+ *
+ */
+export class QueueEvents extends QueueBase {
+    constructor(name, _a = {}, Connection) {
+        var { connection, autorun = true } = _a, opts = __rest(_a, ["connection", "autorun"]);
+        super(name, Object.assign(Object.assign({}, opts), { connection: isRedisInstance(connection)
+                ? connection.duplicate()
+                : connection }), Connection);
+        this.running = false;
+        this.opts = Object.assign({
+            blockingTimeout: 10000,
+        }, this.opts);
+        if (autorun) {
+            this.run().catch(error => this.emit('error', error));
+        }
+    }
+    emit(event, ...args) {
+        return super.emit(event, ...args);
+    }
+    off(eventName, listener) {
+        super.off(eventName, listener);
+        return this;
+    }
+    on(event, listener) {
+        super.on(event, listener);
+        return this;
+    }
+    once(event, listener) {
+        super.once(event, listener);
+        return this;
+    }
+    async run() {
+        if (!this.running) {
+            try {
+                this.running = true;
+                const client = await this.client;
+                await this.consumeEvents(client);
+            }
+            catch (error) {
+                this.running = false;
+                throw error;
+            }
+        }
+        else {
+            throw new Error('Queue Events is already running.');
+        }
+    }
+    async consumeEvents(client) {
+        const opts = this.opts;
+        const key = this.keys.events;
+        let id = opts.lastEventId || '$';
+        while (!this.closing) {
+            try {
+                // Cast to actual return type, see: https://github.com/DefinitelyTyped/DefinitelyTyped/issues/44301
+                const data = (await client.xread('BLOCK', opts.blockingTimeout, 'STREAMS', key, id));
+                if (data) {
+                    const stream = data[0];
+                    const events = stream[1];
+                    for (let i = 0; i < events.length; i++) {
+                        id = events[i][0];
+                        const args = array2obj(events[i][1]);
+                        //
+                        // TODO: we may need to have a separate xtream for progress data
+                        // to avoid this hack.
+                        switch (args.event) {
+                            case 'progress':
+                                args.data = JSON.parse(args.data);
+                                break;
+                            case 'completed':
+                                args.returnvalue = JSON.parse(args.returnvalue);
+                                break;
+                        }
+                        const { event } = args, restArgs = __rest(args, ["event"]);
+                        if (event === 'drained') {
+                            this.emit(event, id);
+                        }
+                        else {
+                            this.emit(event, restArgs, id);
+                            this.emit(`${event}:${restArgs.jobId}`, restArgs, id);
+                        }
+                    }
+                }
+            }
+            catch (err) {
+                if (isNotConnectionError(err)) {
+                    throw err;
+                }
+                await delay(DELAY_TIME_5);
+            }
+        }
+    }
+    close() {
+        if (!this.closing) {
+            this.closing = this.disconnect();
+        }
+        return this.closing;
+    }
+}
+//# sourceMappingURL=queue-events.js.map

package/dist/esm/classes/queue-events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queue-events.js","sourceRoot":"","sources":["../../../src/classes/queue-events.ts"],"names":[],"mappings":";AACA,OAAO,EACL,SAAS,EACT,KAAK,EACL,oBAAoB,EACpB,eAAe,GAChB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAkIzC;;;;;;GAMG;AACH,MAAM,OAAO,WAAY,SAAQ,SAAS;IAkCxC,YACE,IAAY,EACZ,KAA8D,EAAE,EAChE,UAAmC;YADnC,EAAE,UAAU,EAAE,OAAO,GAAG,IAAI,OAAoC,EAA/B,IAAI,cAArC,yBAAuC,CAAF;QAGrC,KAAK,CACH,IAAI,kCAEC,IAAI,KACP,UAAU,EAAE,eAAe,CAAC,UAAU,CAAC;gBACrC,CAAC,CAAe,UAAW,CAAC,SAAS,EAAE;gBACvC,CAAC,CAAC,UAAU,KAEhB,UAAU,CACX,CAAC;QA/CI,YAAO,GAAG,KAAK,CAAC;QAiDtB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,MAAM,CACvB;YACE,eAAe,EAAE,KAAK;SACvB,EACD,IAAI,CAAC,IAAI,CACV,CAAC;QAEF,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;SACtD;IACH,CAAC;IAzDD,IAAI,CACF,KAAQ,EACR,GAAG,IAAwC;QAE3C,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,GAAG,CACD,SAAY,EACZ,QAAgC;QAEhC,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,EAAE,CACA,KAAQ,EACR,QAAgC;QAEhC,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CACF,KAAQ,EACR,QAAgC;QAEhC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IA8BD,KAAK,CAAC,GAAG;QACP,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,IAAI;gBACF,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;gBACpB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC;gBAEjC,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;aAClC;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;gBACrB,MAAM,KAAK,CAAC;aACb;SACF;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;SACrD;IACH,CAAC;IAEO,KAAK,CAAC,aAAa,CAAC,MAAmB;QAC7C,MAAM,IAAI,GAAuB,IAAI,CAAC,IAAI,CAAC;QAE3C,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;QAC7B,IAAI,EAAE,GAAG,IAAI,CAAC,WAAW,IAAI,GAAG,CAAC;QAEjC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE;YACpB,IAAI;gBACF,mGAAmG;gBACnG,MAAM,IAAI,GAAkB,CAAC,MAAM,MAAM,CAAC,KAAK,CAC7C,OAAO,EACP,IAAI,CAAC,eAAe,EACpB,SAAS,EACT,GAAG,EACH,EAAE,CACH,CAAQ,CAAC;gBAEV,IAAI,IAAI,EAAE;oBACR,MAAM,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;oBACvB,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;oBAEzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;wBACtC,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;wBAClB,MAAM,IAAI,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;wBAErC,EAAE;wBACF,gEAAgE;wBAChE,sBAAsB;wBACtB,QAAQ,IAAI,CAAC,KAAK,EAAE;4BAClB,KAAK,UAAU;gCACb,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gCAClC,MAAM;4BACR,KAAK,WAAW;gCACd,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gCAChD,MAAM;yBACT;wBAED,MAAM,EAAE,KAAK,KAAkB,IAAI,EAAjB,QAAQ,UAAK,IAAI,EAA7B,SAAsB,CAAO,CAAC;wBAEpC,IAAI,KAAK,KAAK,SAAS,EAAE;4BACvB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;yBACtB;6BAAM;4BACL,IAAI,CAAC,IAAI,CAAC,KAAY,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;4BACtC,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,IAAI,QAAQ,CAAC,KAAK,EAAS,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;yBAC9D;qBACF;iBACF;aACF;YAAC,OAAO,GAAG,EAAE;gBACZ,IAAI,oBAAoB,CAAC,GAAY,CAAC,EAAE;oBACtC,MAAM,GAAG,CAAC;iBACX;gBAED,MAAM,KAAK,CAAC,YAAY,CAAC,CAAC;aAC3B;SACF;IACH,CAAC;IAED,KAAK;QACH,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;SAClC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF"}

package/dist/esm/classes/queue-getters.d.ts

@@ -0,0 +1,54 @@
+import { QueueBase } from './queue-base';
+import { Job } from './job';
+export declare class QueueGetters extends QueueBase {
+    getJob(jobId: string): Promise<Job | undefined>;
+    private commandByType;
+    /**
+      Returns the number of jobs waiting to be processed.
+    */
+    count(): Promise<number>;
+    /**
+     * Job counts by type
+     *
+     * Queue#getJobCountByTypes('completed') => completed count
+     * Queue#getJobCountByTypes('completed,failed') => completed + failed count
+     * Queue#getJobCountByTypes('completed', 'failed') => completed + failed count
+     * Queue#getJobCountByTypes('completed', 'waiting', 'failed') => completed + waiting + failed count
+     */
+    getJobCountByTypes(...types: string[]): Promise<number>;
+    /**
+     * Returns the job counts for each type specified or every list/set in the queue by default.
+     *
+     * @returns An object, key (type) and value (count)
+     */
+    getJobCounts(...types: string[]): Promise<{
+        [index: string]: number;
+    }>;
+    getCompletedCount(): Promise<number>;
+    getFailedCount(): Promise<number>;
+    getDelayedCount(): Promise<number>;
+    getActiveCount(): Promise<number>;
+    getWaitingCount(): Promise<number>;
+    getWaitingChildrenCount(): Promise<number>;
+    getWaiting(start?: number, end?: number): Promise<Job<any, any, string>[]>;
+    getWaitingChildren(start?: number, end?: number): Promise<Job<any, any, string>[]>;
+    getActive(start?: number, end?: number): Promise<Job<any, any, string>[]>;
+    getDelayed(start?: number, end?: number): Promise<Job<any, any, string>[]>;
+    getCompleted(start?: number, end?: number): Promise<Job<any, any, string>[]>;
+    getFailed(start?: number, end?: number): Promise<Job<any, any, string>[]>;
+    getRanges(types: string[], start?: number, end?: number, asc?: boolean): Promise<any[]>;
+    getJobs(types: string[] | string, start?: number, end?: number, asc?: boolean): Promise<Job<any, any, string>[]>;
+    getJobLogs(jobId: string, start?: number, end?: number, asc?: boolean): Promise<{
+        logs: [string];
+        count: number;
+    }>;
+    /**
+     * Get worker list related to the queue.
+     *
+     * @returns - Returns an array with workers info.
+     */
+    getWorkers(): Promise<{
+        [index: string]: string;
+    }[]>;
+    private parseClientList;
+}