chore(release): 1.24.0 [skip ci]

# [1.24.0](v1.23.1...v1.24.0) (2021-05-03) ### Features * add option for non-blocking getNextJob ([13ce2cf](13ce2cf))
taskforcesh · May 3, 2021 · b75b4f1 · b75b4f1
1 parent 13ce2cf
commit b75b4f1
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 3 deletions.
diff --git a/docs/gitbook/CHANGELOG.md b/docs/gitbook/CHANGELOG.md
@@ -1,3 +1,10 @@
+# [1.24.0](https://github.com/taskforcesh/bullmq/compare/v1.23.1...v1.24.0) (2021-05-03)
+
+
+### Features
+
+* add option for non-blocking getNextJob ([13ce2cf](https://github.com/taskforcesh/bullmq/commit/13ce2cfd4ccd64f45567df31de11af95b0fe67d9))
+
 ## [1.23.1](https://github.com/taskforcesh/bullmq/compare/v1.23.0...v1.23.1) (2021-05-03)
 
 

diff --git a/docs/gitbook/api/bullmq.getnextjoboptions.block.md b/docs/gitbook/api/bullmq.getnextjoboptions.block.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; [GetNextJobOptions](./bullmq.getnextjoboptions.md) &gt; [block](./bullmq.getnextjoboptions.block.md)
+
+## GetNextJobOptions.block property
+
+<b>Signature:</b>
+
+```typescript
+block?: boolean;
+```
diff --git a/docs/gitbook/api/bullmq.getnextjoboptions.md b/docs/gitbook/api/bullmq.getnextjoboptions.md
@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bullmq](./bullmq.md) &gt; [GetNextJobOptions](./bullmq.getnextjoboptions.md)
+
+## GetNextJobOptions interface
+
+<b>Signature:</b>
+
+```typescript
+export interface GetNextJobOptions 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [block?](./bullmq.getnextjoboptions.block.md) | boolean | <i>(Optional)</i> |
+
diff --git a/docs/gitbook/api/bullmq.md b/docs/gitbook/api/bullmq.md
@@ -43,6 +43,7 @@
 |  [BackoffOptions](./bullmq.backoffoptions.md) | Settings for backing off failed jobs. |
 |  [ChildProcessExt](./bullmq.childprocessext.md) |  |
 |  [FlowJob](./bullmq.flowjob.md) |  |
+|  [GetNextJobOptions](./bullmq.getnextjoboptions.md) |  |
 |  [JobJson](./bullmq.jobjson.md) |  |
 |  [JobJsonRaw](./bullmq.jobjsonraw.md) |  |
 |  [JobNode](./bullmq.jobnode.md) |  |

diff --git a/docs/gitbook/api/bullmq.worker.getnextjob.md b/docs/gitbook/api/bullmq.worker.getnextjob.md
@@ -9,14 +9,15 @@ Returns a promise that resolves to the next job in queue.
 <b>Signature:</b>
 
 ```typescript
-getNextJob(token: string): Promise<Job<any, any, string>>;
+getNextJob(token: string, { block }?: GetNextJobOptions): Promise<Job<any, any, string>>;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  token | string | worker token to be assigned to retrieved job |
+|  { block } | [GetNextJobOptions](./bullmq.getnextjoboptions.md) |  |
 
 <b>Returns:</b>
 

diff --git a/docs/gitbook/api/bullmq.worker.md b/docs/gitbook/api/bullmq.worker.md
@@ -29,7 +29,7 @@ export declare class Worker<T = any, R = any, N extends string = string> extends
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
 |  [close(force)](./bullmq.worker.close.md) |  |  |
-|  [getNextJob(token)](./bullmq.worker.getnextjob.md) |  | Returns a promise that resolves to the next job in queue. |
+|  [getNextJob(token, { block })](./bullmq.worker.getnextjob.md) |  | Returns a promise that resolves to the next job in queue. |
 |  [isPaused()](./bullmq.worker.ispaused.md) |  |  |
 |  [pause(doNotWaitActive)](./bullmq.worker.pause.md) |  | Pauses the processing of this queue only for this worker. |
 |  [processJob(job, token)](./bullmq.worker.processjob.md) |  |  |

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "bullmq",
-  "version": "1.23.1",
+  "version": "1.24.0",
   "description": "Queue for messages and jobs based on Redis",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",