chore(release): 1.67.0 [skip ci]

# [1.67.0](taskforcesh/bullmq@v1.66.1...v1.67.0) (2022-01-26) ### Features * add support for removeOn based on time ([6c4ac75](taskforcesh@6c4ac75))
f11y11 · Jan 26, 2022 · 8c5fcea · 8c5fcea
1 parent 17fee4e
commit 8c5fcea
Show file tree

Hide file tree

Showing 12 changed files with 70 additions and 13 deletions.
diff --git a/docs/gitbook/api/bullmq.jobsoptions.md b/docs/gitbook/api/bullmq.jobsoptions.md
@@ -23,8 +23,8 @@ export interface JobsOptions
 |  [prevMillis?](./bullmq.jobsoptions.prevmillis.md) | number | <i>(Optional)</i> Internal property used by repeatable jobs. |
 |  [priority?](./bullmq.jobsoptions.priority.md) | number | <i>(Optional)</i> Ranges from 1 (highest priority) to MAX\_INT (lowest priority). Note that using priorities has a slight impact on performance, so do not use it if not required. |
 |  [rateLimiterKey?](./bullmq.jobsoptions.ratelimiterkey.md) | string | <i>(Optional)</i> Rate limiter key to use if rate limiter enabled. |
-|  [removeOnComplete?](./bullmq.jobsoptions.removeoncomplete.md) | boolean \| number | <i>(Optional)</i> If true, removes the job when it successfully completes When given an number, it specifies the maximum amount of jobs to keep. Default behavior is to keep the job in the completed set. |
-|  [removeOnFail?](./bullmq.jobsoptions.removeonfail.md) | boolean \| number | <i>(Optional)</i> If true, removes the job when it fails after all attempts. When given an number, it specifies the maximum amount of jobs to keep. |
+|  [removeOnComplete?](./bullmq.jobsoptions.removeoncomplete.md) | boolean \| number \| [KeepJobs](./bullmq.keepjobs.md) | <i>(Optional)</i> If true, removes the job when it successfully completes When given an number, it specifies the maximum amount of jobs to keep, or you can provide an object specifying max age and/or count to keep. Default behavior is to keep the job in the completed set. |
+|  [removeOnFail?](./bullmq.jobsoptions.removeonfail.md) | boolean \| number \| [KeepJobs](./bullmq.keepjobs.md) | <i>(Optional)</i> If true, removes the job when it fails after all attempts. When given an number, it specifies the maximum amount of jobs to keep, or you can provide an object specifying max age and/or count to keep. |
 |  [repeat?](./bullmq.jobsoptions.repeat.md) | [RepeatOptions](./bullmq.repeatoptions.md) | <i>(Optional)</i> Repeat this job, for example based on a <code>cron</code> schedule. |
 |  [sizeLimit?](./bullmq.jobsoptions.sizelimit.md) | number | <i>(Optional)</i> Limits the size in bytes of the job's data payload (as a JSON serialized string). |
 |  [stackTraceLimit?](./bullmq.jobsoptions.stacktracelimit.md) | number | <i>(Optional)</i> Limits the amount of stack trace lines that will be recorded in the stacktrace. |

diff --git a/docs/gitbook/api/bullmq.jobsoptions.removeoncomplete.md b/docs/gitbook/api/bullmq.jobsoptions.removeoncomplete.md
@@ -4,10 +4,10 @@
 
 ## JobsOptions.removeOnComplete property
 
-If true, removes the job when it successfully completes When given an number, it specifies the maximum amount of jobs to keep. Default behavior is to keep the job in the completed set.
+If true, removes the job when it successfully completes When given an number, it specifies the maximum amount of jobs to keep, or you can provide an object specifying max age and/or count to keep. Default behavior is to keep the job in the completed set.
 
 <b>Signature:</b>
 
 ```typescript
-removeOnComplete?: boolean | number;
+removeOnComplete?: boolean | number | KeepJobs;
 ```
diff --git a/docs/gitbook/api/bullmq.jobsoptions.removeonfail.md b/docs/gitbook/api/bullmq.jobsoptions.removeonfail.md
@@ -4,10 +4,10 @@
 
 ## JobsOptions.removeOnFail property
 
-If true, removes the job when it fails after all attempts. When given an number, it specifies the maximum amount of jobs to keep.
+If true, removes the job when it fails after all attempts. When given an number, it specifies the maximum amount of jobs to keep, or you can provide an object specifying max age and/or count to keep.
 
 <b>Signature:</b>
 
 ```typescript
-removeOnFail?: boolean | number;
+removeOnFail?: boolean | number | KeepJobs;
 ```
diff --git a/docs/gitbook/api/bullmq.keepjobs.age.md b/docs/gitbook/api/bullmq.keepjobs.age.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bullmq](./bullmq.md) &gt; [KeepJobs](./bullmq.keepjobs.md) &gt; [age](./bullmq.keepjobs.age.md)
+
+## KeepJobs.age property
+
+Maximum age in seconds for job to be kept.
+
+<b>Signature:</b>
+
+```typescript
+age?: number;
+```
diff --git a/docs/gitbook/api/bullmq.keepjobs.count.md b/docs/gitbook/api/bullmq.keepjobs.count.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bullmq](./bullmq.md) &gt; [KeepJobs](./bullmq.keepjobs.md) &gt; [count](./bullmq.keepjobs.count.md)
+
+## KeepJobs.count property
+
+Maximum count of jobs to be kept.
+
+<b>Signature:</b>
+
+```typescript
+count?: number;
+```
diff --git a/docs/gitbook/api/bullmq.keepjobs.md b/docs/gitbook/api/bullmq.keepjobs.md
@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bullmq](./bullmq.md) &gt; [KeepJobs](./bullmq.keepjobs.md)
+
+## KeepJobs interface
+
+KeepJobs
+
+Specify which jobs to keep after finishing. If both age and count are specified, then the jobs kept will be the ones that satisfies both properties.
+
+<b>Signature:</b>
+
+```typescript
+export interface KeepJobs 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [age?](./bullmq.keepjobs.age.md) | number | <i>(Optional)</i> Maximum age in seconds for job to be kept. |
+|  [count?](./bullmq.keepjobs.count.md) | number | <i>(Optional)</i> Maximum count of jobs to be kept. |
+
diff --git a/docs/gitbook/api/bullmq.md b/docs/gitbook/api/bullmq.md
@@ -69,6 +69,7 @@
 |  [JobJsonRaw](./bullmq.jobjsonraw.md) |  |
 |  [JobNode](./bullmq.jobnode.md) |  |
 |  [JobsOptions](./bullmq.jobsoptions.md) |  |
+|  [KeepJobs](./bullmq.keepjobs.md) | KeepJobs<!-- -->Specify which jobs to keep after finishing. If both age and count are specified, then the jobs kept will be the ones that satisfies both properties. |
 |  [MoveToChildrenOpts](./bullmq.movetochildrenopts.md) |  |
 |  [NodeOpts](./bullmq.nodeopts.md) |  |
 |  [Parent](./bullmq.parent.md) | Describes the parent for a Job. |

diff --git a/docs/gitbook/api/bullmq.scripts.movetocompleted.md b/docs/gitbook/api/bullmq.scripts.movetocompleted.md
@@ -7,7 +7,7 @@
 <b>Signature:</b>
 
 ```typescript
-static moveToCompleted<T = any, R = any, N extends string = string>(queue: MinimalQueue, job: Job<T, R, N>, returnvalue: any, removeOnComplete: boolean | number, token: string, fetchNext: boolean): Promise<JobData | []>;
+static moveToCompleted<T = any, R = any, N extends string = string>(queue: MinimalQueue, job: Job<T, R, N>, returnvalue: any, removeOnComplete: boolean | number | KeepJobs, token: string, fetchNext: boolean): Promise<JobData | []>;
 ```
 
 ## Parameters
@@ -17,7 +17,7 @@ static moveToCompleted<T = any, R = any, N extends string = string>(queue: Minim
 |  queue | [MinimalQueue](./bullmq.minimalqueue.md) |  |
 |  job | [Job](./bullmq.job.md)<!-- -->&lt;T, R, N&gt; |  |
 |  returnvalue | any |  |
-|  removeOnComplete | boolean \| number |  |
+|  removeOnComplete | boolean \| number \| [KeepJobs](./bullmq.keepjobs.md) |  |
 |  token | string |  |
 |  fetchNext | boolean |  |
 

diff --git a/docs/gitbook/api/bullmq.scripts.movetofailedargs.md b/docs/gitbook/api/bullmq.scripts.movetofailedargs.md
@@ -7,7 +7,7 @@
 <b>Signature:</b>
 
 ```typescript
-static moveToFailedArgs<T = any, R = any, N extends string = string>(queue: MinimalQueue, job: Job<T, R, N>, failedReason: string, removeOnFailed: boolean | number, token: string, fetchNext?: boolean, retriesExhausted?: number): string[];
+static moveToFailedArgs<T = any, R = any, N extends string = string>(queue: MinimalQueue, job: Job<T, R, N>, failedReason: string, removeOnFailed: boolean | number | KeepJobs, token: string, fetchNext?: boolean, retriesExhausted?: number): string[];
 ```
 
 ## Parameters
@@ -17,7 +17,7 @@ static moveToFailedArgs<T = any, R = any, N extends string = string>(queue: Mini
 |  queue | [MinimalQueue](./bullmq.minimalqueue.md) |  |
 |  job | [Job](./bullmq.job.md)<!-- -->&lt;T, R, N&gt; |  |
 |  failedReason | string |  |
-|  removeOnFailed | boolean \| number |  |
+|  removeOnFailed | boolean \| number \| [KeepJobs](./bullmq.keepjobs.md) |  |
 |  token | string |  |
 |  fetchNext | boolean |  |
 |  retriesExhausted | number |  |

diff --git a/docs/gitbook/api/bullmq.scripts.movetofinishedargs.md b/docs/gitbook/api/bullmq.scripts.movetofinishedargs.md
@@ -7,7 +7,7 @@
 <b>Signature:</b>
 
 ```typescript
-static moveToFinishedArgs<T = any, R = any, N extends string = string>(queue: MinimalQueue, job: Job<T, R, N>, val: any, propVal: FinishedPropValAttribute, shouldRemove: boolean | number, target: FinishedTarget, token: string, fetchNext?: boolean): string[];
+static moveToFinishedArgs<T = any, R = any, N extends string = string>(queue: MinimalQueue, job: Job<T, R, N>, val: any, propVal: FinishedPropValAttribute, shouldRemove: boolean | number | KeepJobs, target: FinishedTarget, token: string, fetchNext?: boolean): string[];
 ```
 
 ## Parameters
@@ -18,7 +18,7 @@ static moveToFinishedArgs<T = any, R = any, N extends string = string>(queue: Mi
 |  job | [Job](./bullmq.job.md)<!-- -->&lt;T, R, N&gt; |  |
 |  val | any |  |
 |  propVal | [FinishedPropValAttribute](./bullmq.finishedpropvalattribute.md) |  |
-|  shouldRemove | boolean \| number |  |
+|  shouldRemove | boolean \| number \| [KeepJobs](./bullmq.keepjobs.md) |  |
 |  target | [FinishedTarget](./bullmq.finishedtarget.md) |  |
 |  token | string |  |
 |  fetchNext | boolean |  |

diff --git a/docs/gitbook/changelog.md b/docs/gitbook/changelog.md
@@ -1,3 +1,10 @@
+# [1.67.0](https://github.com/taskforcesh/bullmq/compare/v1.66.1...v1.67.0) (2022-01-26)
+
+
+### Features
+
+* add support for removeOn based on time ([6c4ac75](https://github.com/taskforcesh/bullmq/commit/6c4ac75bb3ac239cc83ef6144d69c04b2bba1311))
+
 ## [1.66.1](https://github.com/taskforcesh/bullmq/compare/v1.66.0...v1.66.1) (2022-01-25)
 
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "bullmq",
-  "version": "1.66.1",
+  "version": "1.67.0",
   "description": "Queue for messages and jobs based on Redis",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",