chore(release): 1.18.0 [skip ci]

# [1.18.0](v1.17.0...v1.18.0) (2021-04-16)

### Features

* add remove support for flows ([4e8a7ef](4e8a7ef))

Author: semantic-release-bot

docs/gitbook/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.18.0](https://github.com/taskforcesh/bullmq/compare/v1.17.0...v1.18.0) (2021-04-16)
+
+
+### Features
+
+* add remove support for flows ([4e8a7ef](https://github.com/taskforcesh/bullmq/commit/4e8a7efd53f918937478ae13f5da7dee9ea9d8b3))
+
 # [1.17.0](https://github.com/taskforcesh/bullmq/compare/v1.16.2...v1.17.0) (2021-04-16)
 
 

docs/gitbook/api/bullmq.flow.add.md

@@ -24,5 +24,5 @@ add(flow: FlowJob): Promise<JobNode>;
 
 <b>Returns:</b>
 
-Promise&lt;JobNode&gt;
+Promise&lt;[JobNode](./bullmq.jobnode.md)<!-- -->&gt;
 

docs/gitbook/api/bullmq.jobnode.children.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bullmq](./bullmq.md) &gt; [JobNode](./bullmq.jobnode.md) &gt; [children](./bullmq.jobnode.children.md)
+
+## JobNode.children property
+
+<b>Signature:</b>
+
+```typescript
+children?: JobNode[];
+```

docs/gitbook/api/bullmq.jobnode.job.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bullmq](./bullmq.md) &gt; [JobNode](./bullmq.jobnode.md) &gt; [job](./bullmq.jobnode.job.md)
+
+## JobNode.job property
+
+<b>Signature:</b>
+
+```typescript
+job: Job;
+```

docs/gitbook/api/bullmq.jobnode.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bullmq](./bullmq.md) &gt; [JobNode](./bullmq.jobnode.md)
+
+## JobNode interface
+
+<b>Signature:</b>
+
+```typescript
+export interface JobNode 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [children?](./bullmq.jobnode.children.md) | [JobNode](./bullmq.jobnode.md)<!-- -->\[\] | <i>(Optional)</i> |
+|  [job](./bullmq.jobnode.job.md) | [Job](./bullmq.job.md) |  |
+

docs/gitbook/api/bullmq.md

@@ -37,6 +37,7 @@
 |  [BackoffOptions](./bullmq.backoffoptions.md) | Settings for backing off failed jobs. |
 |  [ChildProcessExt](./bullmq.childprocessext.md) |  |
 |  [JobJson](./bullmq.jobjson.md) |  |
+|  [JobNode](./bullmq.jobnode.md) |  |
 |  [JobsOptions](./bullmq.jobsoptions.md) |  |
 |  [QueueBaseOptions](./bullmq.queuebaseoptions.md) |  |
 |  [QueueEvents](./bullmq.queueevents.md) |  |

docs/gitbook/api/bullmq.parentopts.md

@@ -10,5 +10,6 @@
 export declare type ParentOpts = {
     waitChildrenKey?: string;
     parentDependenciesKey?: string;
+    parentKey?: string;
 };
 ```

docs/gitbook/api/bullmq.queue.getrepeatablejobs.md

@@ -11,7 +11,12 @@ getRepeatableJobs(start?: number, end?: number, asc?: boolean): Promise<{
         key: string;
         name: string;
         id: string;
-        endDate: number;
+        endDate: number; /**
+         * Drains the queue, i.e., removes all jobs that are waiting
+         * or delayed, but not active, completed or failed.
+         *
+         * TODO: Convert to an atomic LUA script.
+         */
         tz: string;
         cron: string;
         next: number;
@@ -28,5 +33,5 @@ getRepeatableJobs(start?: number, end?: number, asc?: boolean): Promise<{
 
 <b>Returns:</b>
 
-Promise&lt;{ key: string; name: string; id: string; endDate: number; tz: string; cron: string; next: number; }\[\]&gt;
+Promise&lt;{ key: string; name: string; id: string; endDate: number; /\*\* \* Drains the queue, i.e., removes all jobs that are waiting \* or delayed, but not active, completed or failed. \* \* TODO: Convert to an atomic LUA script. \*/ tz: string; cron: string; next: number; }\[\]&gt;
 

docs/gitbook/api/bullmq.queue.md

@@ -39,6 +39,7 @@ export declare class Queue<T = any, R = any, N extends string = string> extends
 |  [isPaused()](./bullmq.queue.ispaused.md) |  |  |
 |  [obliterate(opts)](./bullmq.queue.obliterate.md) |  |  |
 |  [pause()](./bullmq.queue.pause.md) |  | Pauses the processing of this queue globally.<!-- -->We use an atomic RENAME operation on the wait queue. Since we have blocking calls with BRPOPLPUSH on the wait queue, as long as the queue is renamed to 'paused', no new jobs will be processed (the current ones will run until finalized).<!-- -->Adding jobs requires a LUA script to check first if the paused list exist and in that case it will add it there instead of the wait list. |
+|  [remove(jobId)](./bullmq.queue.remove.md) |  | Removes the given job from the queue as well as all its dependencies. |
 |  [removeRepeatable(name, repeatOpts, jobId)](./bullmq.queue.removerepeatable.md) |  |  |
 |  [removeRepeatableByKey(key)](./bullmq.queue.removerepeatablebykey.md) |  |  |
 |  [resume()](./bullmq.queue.resume.md) |  |  |

docs/gitbook/api/bullmq.queue.remove.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bullmq](./bullmq.md) &gt; [Queue](./bullmq.queue.md) &gt; [remove](./bullmq.queue.remove.md)
+
+## Queue.remove() method
+
+Removes the given job from the queue as well as all its dependencies.
+
+<b>Signature:</b>
+
+```typescript
+remove(jobId: string): Promise<any>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  jobId | string | The if of the job to remove |
+
+<b>Returns:</b>
+
+Promise&lt;any&gt;
+
+1 if it managed to remove the job or -1 if the job or any of its dependencies was locked.
+

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bullmq",
-  "version": "1.17.0",
+  "version": "1.18.0",
   "description": "Queue for messages and jobs based on Redis",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",