fix(queue): get rid of repeat options from defaultJobOptions (#1284)

taskforcesh · Jun 16, 2022 · cdd2a20 · cdd2a20
1 parent 1769ce1
commit cdd2a20
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 34 deletions.
diff --git a/src/classes/queue.ts b/src/classes/queue.ts
@@ -1,6 +1,7 @@
 import { get } from 'lodash';
 import { v4 } from 'uuid';
 import {
+  BaseJobOptions,
   IoredisListener,
   JobsOptions,
   QueueOptions,
@@ -94,7 +95,7 @@ export class Queue<
   NameType extends string = string,
 > extends QueueGetters<DataType, ResultType, NameType> {
   token = v4();
-  jobsOpts: JobsOptions;
+  jobsOpts: BaseJobOptions;
   limiter: {
     groupKey: string;
   } = null;

diff --git a/src/interfaces/jobs-options.ts b/src/interfaces/jobs-options.ts
@@ -1,6 +1,6 @@
 import { RepeatOptions, KeepJobs, BackoffOptions } from './';
 
-export interface JobsOptions {
+export interface BaseJobOptions {
   /**
    * Timestamp when the job was created.
    * @defaultValue Date.now()
@@ -28,16 +28,6 @@ export interface JobsOptions {
    */
   attempts?: number;
 
-  /**
-   * Repeat this job, for example based on a `cron` schedule.
-   */
-  repeat?: RepeatOptions;
-
-  /**
-   * Base repeat job key.
-   */
-  repeatJobKey?: string;
-
   /**
    * Rate limiter key to use if rate limiter enabled.
    *
@@ -57,21 +47,6 @@ export interface JobsOptions {
    */
   lifo?: boolean;
 
-  /**
-   * The number of milliseconds after which the job should be
-   * fail with a timeout error.
-   */
-  timeout?: number;
-
-  /**
-   * Override the job ID - by default, the job ID is a unique
-   * integer, but you can use this setting to override it.
-   * If you use this option, it is up to you to ensure the
-   * jobId is unique. If you attempt to add a job with an id that
-   * already exists, it will not be added.
-   */
-  jobId?: string;
-
   /**
    * If true, removes the job when it successfully completes
    * When given an number, it specifies the maximum amount of
@@ -94,6 +69,32 @@ export interface JobsOptions {
    */
   stackTraceLimit?: number;
 
+  /**
+   * Limits the size in bytes of the job's data payload (as a JSON serialized string).
+   */
+  sizeLimit?: number;
+}
+
+export interface JobsOptions extends BaseJobOptions {
+  /**
+   * Repeat this job, for example based on a `cron` schedule.
+   */
+  repeat?: RepeatOptions;
+
+  /**
+   * Internal property used by repeatable jobs to save base repeat job key.
+   */
+  repeatJobKey?: string;
+
+  /**
+   * Override the job ID - by default, the job ID is a unique
+   * integer, but you can use this setting to override it.
+   * If you use this option, it is up to you to ensure the
+   * jobId is unique. If you attempt to add a job with an id that
+   * already exists, it will not be added.
+   */
+  jobId?: string;
+
   /**
    *
    */
@@ -106,9 +107,4 @@ export interface JobsOptions {
    * Internal property used by repeatable jobs.
    */
   prevMillis?: number;
-
-  /**
-   * Limits the size in bytes of the job's data payload (as a JSON serialized string).
-   */
-  sizeLimit?: number;
 }
diff --git a/src/interfaces/queue-options.ts b/src/interfaces/queue-options.ts
@@ -1,4 +1,4 @@
-import { JobsOptions } from './jobs-options';
+import { BaseJobOptions } from './jobs-options';
 import { ConnectionOptions } from './redis-options';
 
 export enum ClientType {
@@ -35,7 +35,7 @@ export interface QueueBaseOptions {
  * Options for the Queue class.
  */
 export interface QueueOptions extends QueueBaseOptions {
-  defaultJobOptions?: JobsOptions;
+  defaultJobOptions?: BaseJobOptions;
 
   /**
    * Options for the rate limiter.