@tachybase/plugin-adapter-bullmq 1.3.16 → 1.3.18

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

@@ -1,3 +1,4 @@
+import { JobProgress } from '../types';
 import { IoredisListener, QueueEventsOptions } from '../interfaces';
 import { QueueBase } from './queue-base';
 import { RedisConnection } from './redis-connection';
@@ -5,7 +6,13 @@ export interface QueueEventsListener extends IoredisListener {
     /**
      * Listen to 'active' event.
      *
-     * This event is triggered when a job enters the 'active' state.
+     * This event is triggered when a job enters the 'active' state, meaning it is being processed.
+     *
+     * @param args - An object containing details about the job that became active.
+     *   - `jobId`: The unique identifier of the job that entered the active state.
+     *   - `prev`: The previous state of the job before it became active (e.g., 'waiting'), if applicable.
+     *
+     * @param id - The identifier of the event.
      */
     active: (args: {
         jobId: string;
@@ -14,7 +21,12 @@ export interface QueueEventsListener extends IoredisListener {
     /**
      * Listen to 'added' event.
      *
-     * This event is triggered when a job is created.
+     * This event is triggered when a job is created and added to the queue.
+     *
+     * @param args - An object containing details about the newly added job.
+     *   - `jobId` - The unique identifier of the job that was added.
+     *   - `name` - The name of the job, typically indicating its type or purpose.
+     * @param id - The identifier of the event.
      */
     added: (args: {
         jobId: string;
@@ -23,7 +35,11 @@ export interface QueueEventsListener extends IoredisListener {
     /**
      * Listen to 'cleaned' event.
      *
-     * This event is triggered when a cleaned method is triggered.
+     * This event is triggered when jobs are cleaned (e.g., removed) from the queue, typically via a cleanup method.
+     *
+     * @param args - An object containing the count of cleaned jobs.
+     *   - `count` - The number of jobs that were cleaned, represented as a string due to Redis serialization.
+     * @param id - The identifier of the event.
      */
     cleaned: (args: {
         count: string;
@@ -31,7 +47,13 @@ export interface QueueEventsListener extends IoredisListener {
     /**
      * Listen to 'completed' event.
      *
-     * This event is triggered when a job has successfully completed.
+     * This event is triggered when a job has successfully completed its execution.
+     *
+     * @param args - An object containing details about the completed job.
+     *   - `jobId` - The unique identifier of the job that completed.
+     *   - `returnvalue` - The return value of the job, serialized as a string.
+     *   - `prev` - The previous state of the job before completion (e.g., 'active'), if applicable.
+     * @param id - The identifier of the event.
      */
     completed: (args: {
         jobId: string;
@@ -40,9 +62,15 @@ export interface QueueEventsListener extends IoredisListener {
     }, id: string) => void;
     /**
      * Listen to 'debounced' event.
-     * @deprecated use deduplicated event
      *
-     * This event is triggered when a job is debounced because debounceId still existed.
+     * @deprecated Use the 'deduplicated' event instead.
+     *
+     * This event is triggered when a job is debounced because a job with the same debounceId still exists.
+     *
+     * @param args - An object containing details about the debounced job.
+     *   - `jobId` - The unique identifier of the job that was debounced.
+     *   - `debounceId` - The identifier used to debounce the job, preventing duplicate processing.
+     * @param id - The identifier of the event.
      */
     debounced: (args: {
         jobId: string;
@@ -51,16 +79,29 @@ export interface QueueEventsListener extends IoredisListener {
     /**
      * Listen to 'deduplicated' event.
      *
-     * This event is triggered when a job is deduplicated because deduplicatedId still existed.
+     * This event is triggered when a job is not added to the queue because a job with the same deduplicationId
+     * already exists.
+     *
+     * @param args - An object containing details about the deduplicated job.
+     *  - `jobId` - The unique identifier of the job that was attempted to be added.
+     *  - `deduplicationId` - The deduplication identifier that caused the job to be deduplicated.
+     *  - `deduplicatedJobId` - The unique identifier of the existing job that caused the deduplication.
+     * @param id - The identifier of the event.
      */
     deduplicated: (args: {
         jobId: string;
         deduplicationId: string;
+        deduplicatedJobId: string;
     }, id: string) => void;
     /**
      * Listen to 'delayed' event.
      *
-     * This event is triggered when a job is delayed.
+     * This event is triggered when a job is scheduled with a delay before it becomes active.
+     *
+     * @param args - An object containing details about the delayed job.
+     *  - `jobId` - The unique identifier of the job that was delayed.
+     *  - `delay` - The delay duration in milliseconds before the job becomes active.
+     * @param id - The identifier of the event.
      */
     delayed: (args: {
         jobId: string;
@@ -69,15 +110,22 @@ export interface QueueEventsListener extends IoredisListener {
     /**
      * Listen to 'drained' event.
      *
-     * This event is triggered when the queue has drained the waiting list.
+     * This event is triggered when the queue has drained its waiting list, meaning there are no jobs
+     * in the 'waiting' state.
      * 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.
+     *
+     * @param id - The identifier of the event.
      */
     drained: (id: string) => void;
     /**
      * Listen to 'duplicated' event.
      *
-     * This event is triggered when a job is not created because it already exist.
+     * This event is triggered when a job is not created because a job with the same identifier already exists.
+     *
+     * @param args - An object containing the job identifier.
+     *  - `jobId` - The unique identifier of the job that was attempted to be added.
+     * @param id - The identifier of the event.
      */
     duplicated: (args: {
         jobId: string;
@@ -85,13 +133,19 @@ export interface QueueEventsListener extends IoredisListener {
     /**
      * Listen to 'error' event.
      *
-     * This event is triggered when an exception is thrown.
+     * This event is triggered when an error in the Redis backend is thrown.
      */
     error: (args: Error) => void;
     /**
      * Listen to 'failed' event.
      *
-     * This event is triggered when a job has thrown an exception.
+     * This event is triggered when a job fails by throwing an exception during execution.
+     *
+     * @param args - An object containing details about the failed job.
+     *  - `jobId` - The unique identifier of the job that failed.
+     *  - `failedReason` - The reason or message describing why the job failed.
+     *  - `prev` - The previous state of the job before failure (e.g., 'active'), if applicable.
+     * @param id - The identifier of the event.
      */
     failed: (args: {
         jobId: string;
@@ -101,26 +155,36 @@ export interface QueueEventsListener extends IoredisListener {
     /**
      * Listen to 'paused' event.
      *
-     * This event is triggered when a queue is paused.
+     * This event is triggered when the queue is paused, halting the processing of new jobs.
+     *
+     * @param args - An empty object (no additional data provided).
+     * @param id - The identifier of the event.
      */
-    paused: (args: {}, id: string) => void;
+    paused: (args: object, 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.
+     * This event is triggered when a job updates its progress via the `Job#updateProgress()` method, allowing
+     * progress or custom data to be communicated externally.
+     *
+     * @param args - An object containing the job identifier and progress data.
+     *  - `jobId` - The unique identifier of the job reporting progress.
+     *  - `data` - The progress data, which can be a number (e.g., percentage) or an object with custom data.
+     * @param id - The identifier of the event.
      */
     progress: (args: {
         jobId: string;
-        data: number | object;
+        data: JobProgress;
     }, id: string) => void;
     /**
      * Listen to 'removed' event.
      *
-     * This event is triggered when a job has been manually
-     * removed from the queue.
+     * This event is triggered when a job is manually removed from the queue.
+     *
+     * @param args - An object containing details about the removed job.
+     *  - `jobId` - The unique identifier of the job that was removed.
+     *  - `prev` - The previous state of the job before removal (e.g., 'active' or 'waiting').
+     * @param id - The identifier of the event.
      */
     removed: (args: {
         jobId: string;
@@ -129,13 +193,22 @@ export interface QueueEventsListener extends IoredisListener {
     /**
      * Listen to 'resumed' event.
      *
-     * This event is triggered when a queue is resumed.
+     * This event is triggered when the queue is resumed, allowing job processing to continue.
+     *
+     * @param args - An empty object (no additional data provided).
+     * @param id - The identifier of the event.
      */
-    resumed: (args: {}, id: string) => void;
+    resumed: (args: object, id: string) => void;
     /**
      * Listen to 'retries-exhausted' event.
      *
-     * This event is triggered when a job has retried the maximum attempts.
+     * This event is triggered when a job has exhausted its maximum retry attempts after repeated failures.
+     *
+     * @param args - An object containing details about the job that exhausted retries.
+     *  - `jobId` - The unique identifier of the job that exhausted its retries.
+     *  - `attemptsMade` - The number of retry attempts made, represented as a string
+     * (due to Redis serialization).
+     * @param id - The identifier of the event.
      */
     'retries-exhausted': (args: {
         jobId: string;
@@ -144,9 +217,13 @@ export interface QueueEventsListener extends IoredisListener {
     /**
      * 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.
+     * This event is triggered when a job moves from 'active' back to 'waiting' or
+     * 'failed' because the processor could not renew its lock, indicating a
+     * potential processing issue.
+     *
+     * @param args - An object containing the job identifier.
+     *  - `jobId` - The unique identifier of the job that stalled.
+     * @param id - The identifier of the event.
      */
     stalled: (args: {
         jobId: string;
@@ -154,7 +231,14 @@ export interface QueueEventsListener extends IoredisListener {
     /**
      * Listen to 'waiting' event.
      *
-     * This event is triggered when a job enters the 'waiting' state.
+     * This event is triggered when a job enters the 'waiting' state, indicating it is queued and
+     * awaiting processing.
+     *
+     * @param args - An object containing details about the job in the waiting state.
+     *  - `jobId` - The unique identifier of the job that is waiting.
+     *  - `prev` - The previous state of the job before entering 'waiting' (e.g., 'stalled'),
+     * if applicable.
+     * @param id - The identifier of the event.
      */
     waiting: (args: {
         jobId: string;
@@ -163,7 +247,12 @@ export interface QueueEventsListener extends IoredisListener {
     /**
      * Listen to 'waiting-children' event.
      *
-     * This event is triggered when a job enters the 'waiting-children' state.
+     * This event is triggered when a job enters the 'waiting-children' state, indicating it is
+     * waiting for its child jobs to complete.
+     *
+     * @param args - An object containing the job identifier.
+     *  - `jobId` - The unique identifier of the job waiting for its children.
+     * @param id - The identifier of the event.
      */
     'waiting-children': (args: {
         jobId: string;

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

@@ -3,11 +3,7 @@ import { Job } from './job';
 import { JobState, JobType } from '../types';
 import { JobJsonRaw, Metrics } from '../interfaces';
 /**
- *
- * @class QueueGetters
- * @extends QueueBase
- *
- * @description Provides different getters for different aspects of a queue.
+ * Provides different getters for different aspects of a queue.
  */
 export declare class QueueGetters<JobBase extends Job = Job> extends QueueBase {
     getJob(jobId: string): Promise<JobBase | undefined>;
@@ -43,10 +39,10 @@ export declare class QueueGetters<JobBase extends Job = Job> extends QueueBase {
     /**
      * 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
+     * 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: JobType[]): Promise<number>;
     /**
@@ -152,11 +148,12 @@ export declare class QueueGetters<JobBase extends Job = Job> extends QueueBase {
      * A qualified job id is a string representing the job id in a given queue,
      * for example: "bull:myqueue:jobid".
      *
-     * @param parentId The id of the parent job
-     * @param type "processed" | "pending"
-     * @param opts
+     * @param parentId - The id of the parent job
+     * @param type - "processed" | "pending"
+     * @param opts - Options for the query.
      *
-     * @returns  { items: { id: string, v?: any, err?: string } [], jobs: JobJsonRaw[], total: number}
+     * @returns an object with the following shape:
+     * `{ items: { id: string, v?: any, err?: string } [], jobs: JobJsonRaw[], total: number}`
      */
     getDependencies(parentId: string, type: 'processed' | 'pending', start: number, end: number): Promise<{
         items: {
@@ -232,4 +229,14 @@ export declare class QueueGetters<JobBase extends Job = Job> extends QueueBase {
      */
     getMetrics(type: 'completed' | 'failed', start?: number, end?: number): Promise<Metrics>;
     private parseClientList;
+    /**
+     * Export the metrics for the queue in the Prometheus format.
+     * Automatically exports all the counts returned by getJobCounts().
+     *
+     * @returns - Returns a string with the metrics in the Prometheus format.
+     *
+     * @see {@link https://prometheus.io/docs/instrumenting/exposition_formats/}
+     *
+     **/
+    exportPrometheusMetrics(globalVariables?: Record<string, string>): Promise<string>;
 }

package/dist/node_modules/bullmq/dist/esm/classes/queue-getters.js

@@ -3,11 +3,7 @@
 import { QueueBase } from './queue-base';
 import { clientCommandMessageReg, QUEUE_EVENT_SUFFIX } from '../utils';
 /**
- *
- * @class QueueGetters
- * @extends QueueBase
- *
- * @description Provides different getters for different aspects of a queue.
+ * Provides different getters for different aspects of a queue.
  */
 export class QueueGetters extends QueueBase {
     getJob(jobId) {
@@ -93,10 +89,10 @@ export class QueueGetters extends QueueBase {
     /**
      * 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
+     * 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
      */
     async getJobCountByTypes(...types) {
         const result = await this.getJobCounts(...types);
@@ -247,11 +243,12 @@ export class QueueGetters extends QueueBase {
      * A qualified job id is a string representing the job id in a given queue,
      * for example: "bull:myqueue:jobid".
      *
-     * @param parentId The id of the parent job
-     * @param type "processed" | "pending"
-     * @param opts
+     * @param parentId - The id of the parent job
+     * @param type - "processed" | "pending"
+     * @param opts - Options for the query.
      *
-     * @returns  { items: { id: string, v?: any, err?: string } [], jobs: JobJsonRaw[], total: number}
+     * @returns an object with the following shape:
+     * `{ items: { id: string, v?: any, err?: string } [], jobs: JobJsonRaw[], total: number}`
      */
     async getDependencies(parentId, type, start, end) {
         const key = this.toKey(type == 'processed'
@@ -423,7 +420,7 @@ export class QueueGetters extends QueueBase {
         };
     }
     parseClientList(list, matcher) {
-        const lines = list.split('\n');
+        const lines = list.split(/\r?\n/);
         const clients = [];
         lines.forEach((line) => {
             const client = {};
@@ -443,5 +440,28 @@ export class QueueGetters extends QueueBase {
         });
         return clients;
     }
+    /**
+     * Export the metrics for the queue in the Prometheus format.
+     * Automatically exports all the counts returned by getJobCounts().
+     *
+     * @returns - Returns a string with the metrics in the Prometheus format.
+     *
+     * @see {@link https://prometheus.io/docs/instrumenting/exposition_formats/}
+     *
+     **/
+    async exportPrometheusMetrics(globalVariables) {
+        const counts = await this.getJobCounts();
+        const metrics = [];
+        // Match the test's expected HELP text
+        metrics.push('# HELP bullmq_job_count Number of jobs in the queue by state');
+        metrics.push('# TYPE bullmq_job_count gauge');
+        const variables = !globalVariables
+            ? ''
+            : Object.keys(globalVariables).reduce((acc, curr) => `${acc}, ${curr}="${globalVariables[curr]}"`, '');
+        for (const [state, count] of Object.entries(counts)) {
+            metrics.push(`bullmq_job_count{queue="${this.name}", state="${state}"${variables}} ${count}`);
+        }
+        return metrics.join('\n');
+    }
 }
 //# sourceMappingURL=queue-getters.js.map

package/dist/node_modules/bullmq/dist/esm/classes/queue.d.ts

@@ -1,5 +1,5 @@
 import { BaseJobOptions, BulkJobOptions, IoredisListener, JobSchedulerJson, QueueOptions, RepeatableJob, RepeatOptions } from '../interfaces';
-import { FinishedStatus, JobsOptions, JobSchedulerTemplateOptions } from '../types';
+import { FinishedStatus, JobsOptions, JobSchedulerTemplateOptions, JobProgress } from '../types';
 import { Job } from './job';
 import { QueueGetters } from './queue-getters';
 import { Repeat } from './repeat';
@@ -71,9 +71,9 @@ type ExtractNameType<DataTypeOrJob, Default extends string> = DataTypeOrJob exte
  * This class provides methods to add jobs to a queue and some other high-level
  * administration such as pausing or deleting queues.
  *
- * @template DataType - The type of the data that the job will process.
- * @template ResultType - The type of the result of the job.
- * @template NameType - The type of the name of the job.
+ * @typeParam DataType - The type of the data that the job will process.
+ * @typeParam ResultType - The type of the result of the job.
+ * @typeParam NameType - The type of the name of the job.
  *
  * @example
  *
@@ -96,7 +96,7 @@ export declare class Queue<DataTypeOrJob = any, DefaultResultType = any, Default
     jobsOpts: BaseJobOptions;
     opts: QueueOptions;
     protected libName: string;
-    private _repeat?;
+    protected _repeat?: Repeat;
     protected _jobScheduler?: JobScheduler;
     constructor(name: string, opts?: QueueOptions, Connection?: typeof RedisConnection);
     emit<U extends keyof QueueListener<JobBase<DataType, ResultType, NameType>>>(event: U, ...args: Parameters<QueueListener<JobBase<DataType, ResultType, NameType>>[U]>): boolean;
@@ -129,6 +129,10 @@ export declare class Queue<DataTypeOrJob = any, DefaultResultType = any, Default
      * restriction on the number of concurrent jobs.
      */
     setGlobalConcurrency(concurrency: number): Promise<number>;
+    /**
+     * Remove global concurrency value.
+     */
+    removeGlobalConcurrency(): Promise<number>;
     /**
      * Adds a new job to the queue.
      *
@@ -141,9 +145,9 @@ export declare class Queue<DataTypeOrJob = any, DefaultResultType = any, Default
      * addJob is a telemetry free version of the add method, useful in order to wrap it
      * with custom telemetry on subclasses.
      *
-     * @param name
-     * @param data
-     * @param opts
+     * @param name - Name of the job to be added to the queue.
+     * @param data - Arbitrary data to append to the job.
+     * @param opts - Job options that affects how the job is going to be processed.
      *
      * @returns Job
      */
@@ -220,7 +224,6 @@ export declare class Queue<DataTypeOrJob = any, DefaultResultType = any, Default
     /**
      * Get all repeatable meta jobs.
      *
-     *
      * @deprecated This method is deprecated and will be removed in v6. Use getJobSchedulers instead.
      *
      * @param start - Offset of first job to return.
@@ -262,8 +265,8 @@ export declare class Queue<DataTypeOrJob = any, DefaultResultType = any, Default
      * @see removeRepeatableByKey
      *
      * @param name - Job name
-     * @param repeatOpts -
-     * @param jobId -
+     * @param repeatOpts - Repeat options
+     * @param jobId - Job id to remove. If not provided, all jobs with the same repeatOpts
      * @returns
      */
     removeRepeatable(name: NameType, repeatOpts: RepeatOptions, jobId?: string): Promise<boolean>;
@@ -271,7 +274,7 @@ export declare class Queue<DataTypeOrJob = any, DefaultResultType = any, Default
      *
      * Removes a job scheduler.
      *
-     * @param jobSchedulerId
+     * @param jobSchedulerId - identifier of the job scheduler.
      *
      * @returns
      */
@@ -280,7 +283,7 @@ export declare class Queue<DataTypeOrJob = any, DefaultResultType = any, Default
      * Removes a debounce key.
      * @deprecated use removeDeduplicationKey
      *
-     * @param id - identifier
+     * @param id - debounce identifier
      */
     removeDebounceKey(id: string): Promise<number>;
     /**
@@ -324,7 +327,7 @@ export declare class Queue<DataTypeOrJob = any, DefaultResultType = any, Default
      * @param jobId - The id of the job to update
      * @param progress - Number or object to be saved as progress.
      */
-    updateJobProgress(jobId: string, progress: number | object): Promise<void>;
+    updateJobProgress(jobId: string, progress: JobProgress): Promise<void>;
     /**
      * Logs one row of job's log data.
      *
@@ -369,7 +372,7 @@ export declare class Queue<DataTypeOrJob = any, DefaultResultType = any, Default
     /**
      * Retry all the failed or completed jobs.
      *
-     * @param opts: { count: number; state: FinishedStatus; timestamp: number}
+     * @param opts - An object with the following properties:
      *   - count  number to limit how many jobs will be moved to wait status per iteration,
      *   - state  failed by default or completed.
      *   - timestamp from which timestamp to start moving jobs to wait status, default Date.now().
@@ -384,7 +387,7 @@ export declare class Queue<DataTypeOrJob = any, DefaultResultType = any, Default
     /**
      * Promote all the delayed jobs.
      *
-     * @param opts: { count: number }
+     * @param opts - An object with the following properties:
      *   - count  number to limit how many jobs will be moved to wait status per iteration
      *
      * @returns

package/dist/node_modules/bullmq/dist/esm/classes/queue.js

@@ -11,9 +11,9 @@ import { version } from '../version';
  * This class provides methods to add jobs to a queue and some other high-level
  * administration such as pausing or deleting queues.
  *
- * @template DataType - The type of the data that the job will process.
- * @template ResultType - The type of the result of the job.
- * @template NameType - The type of the name of the job.
+ * @typeParam DataType - The type of the data that the job will process.
+ * @typeParam ResultType - The type of the result of the job.
+ * @typeParam NameType - The type of the name of the job.
  *
  * @example
  *
@@ -127,6 +127,13 @@ export class Queue extends QueueGetters {
         const client = await this.client;
         return client.hset(this.keys.meta, 'concurrency', concurrency);
     }
+    /**
+     * Remove global concurrency value.
+     */
+    async removeGlobalConcurrency() {
+        const client = await this.client;
+        return client.hdel(this.keys.meta, 'concurrency');
+    }
     /**
      * Adds a new job to the queue.
      *
@@ -155,9 +162,9 @@ export class Queue extends QueueGetters {
      * addJob is a telemetry free version of the add method, useful in order to wrap it
      * with custom telemetry on subclasses.
      *
-     * @param name
-     * @param data
-     * @param opts
+     * @param name - Name of the job to be added to the queue.
+     * @param data - Arbitrary data to append to the job.
+     * @param opts - Job options that affects how the job is going to be processed.
      *
      * @returns Job
      */
@@ -313,7 +320,6 @@ export class Queue extends QueueGetters {
     /**
      * Get all repeatable meta jobs.
      *
-     *
      * @deprecated This method is deprecated and will be removed in v6. Use getJobSchedulers instead.
      *
      * @param start - Offset of first job to return.
@@ -363,8 +369,8 @@ export class Queue extends QueueGetters {
      * @see removeRepeatableByKey
      *
      * @param name - Job name
-     * @param repeatOpts -
-     * @param jobId -
+     * @param repeatOpts - Repeat options
+     * @param jobId - Job id to remove. If not provided, all jobs with the same repeatOpts
      * @returns
      */
     async removeRepeatable(name, repeatOpts, jobId) {
@@ -382,7 +388,7 @@ export class Queue extends QueueGetters {
      *
      * Removes a job scheduler.
      *
-     * @param jobSchedulerId
+     * @param jobSchedulerId - identifier of the job scheduler.
      *
      * @returns
      */
@@ -395,7 +401,7 @@ export class Queue extends QueueGetters {
      * Removes a debounce key.
      * @deprecated use removeDeduplicationKey
      *
-     * @param id - identifier
+     * @param id - debounce identifier
      */
     async removeDebounceKey(id) {
         return this.trace(SpanKind.INTERNAL, 'removeDebounceKey', `${this.name}`, async (span) => {
@@ -569,7 +575,7 @@ export class Queue extends QueueGetters {
     /**
      * Retry all the failed or completed jobs.
      *
-     * @param opts: { count: number; state: FinishedStatus; timestamp: number}
+     * @param opts - An object with the following properties:
      *   - count  number to limit how many jobs will be moved to wait status per iteration,
      *   - state  failed by default or completed.
      *   - timestamp from which timestamp to start moving jobs to wait status, default Date.now().
@@ -590,7 +596,7 @@ export class Queue extends QueueGetters {
     /**
      * Promote all the delayed jobs.
      *
-     * @param opts: { count: number }
+     * @param opts - An object with the following properties:
      *   - count  number to limit how many jobs will be moved to wait status per iteration
      *
      * @returns

package/dist/node_modules/bullmq/dist/esm/classes/redis-connection.d.ts

@@ -11,8 +11,7 @@ export interface RawCommand {
     keys: number;
 }
 export declare class RedisConnection extends EventEmitter {
-    private readonly shared;
-    private readonly blocking;
+    private readonly extraOptions?;
     static minimumVersion: string;
     static recommendedMinimumVersion: string;
     closing: boolean;
@@ -27,7 +26,12 @@ export declare class RedisConnection extends EventEmitter {
     private handleClientError;
     private handleClientClose;
     private handleClientReady;
-    constructor(opts?: ConnectionOptions, shared?: boolean, blocking?: boolean, skipVersionCheck?: boolean);
+    constructor(opts: ConnectionOptions, extraOptions?: {
+        shared?: boolean;
+        blocking?: boolean;
+        skipVersionCheck?: boolean;
+        skipWaitingForReady?: boolean;
+    });
     private checkBlockingOptions;
     /**
      * Waits for a redis client to be ready.