chore(release): 1.40.0 [skip ci]

# [1.40.0](v1.39.5...v1.40.0) (2021-07-22) ### Features * **worker:** retry with delay errors in run loop ([409fe7f](409fe7f))
taskforcesh · Jul 22, 2021 · a4984ee · a4984ee
1 parent 3eff55b
commit a4984ee
Show file tree

Hide file tree

Showing 10 changed files with 40 additions and 4 deletions.
diff --git a/docs/gitbook/api/bullmq.md b/docs/gitbook/api/bullmq.md
@@ -20,7 +20,7 @@
 |  [RedisConnection](./bullmq.redisconnection.md) |  |
 |  [Repeat](./bullmq.repeat.md) |  |
 |  [Scripts](./bullmq.scripts.md) |  |
-|  [Worker](./bullmq.worker.md) |  |
+|  [Worker](./bullmq.worker.md) | This class represents a worker that is able to process jobs from the queue. As soon as the class is instantiated it will start processing jobs. |
 
 ## Enumerations
 

diff --git a/docs/gitbook/api/bullmq.worker.close.md b/docs/gitbook/api/bullmq.worker.close.md
@@ -4,6 +4,10 @@
 
 ## Worker.close() method
 
+Closes the worker and related redis connections.
+
+This method waits for current jobs to finalize before returning.
+
 <b>Signature:</b>
 
 ```typescript
@@ -14,9 +18,11 @@ close(force?: boolean): Promise<void>;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  force | boolean |  |
+|  force | boolean | Use force boolean parameter if you do not want to wait for current jobs to be processed. |
 
 <b>Returns:</b>
 
 Promise&lt;void&gt;
 
+Promise that resolves when the worker has been closed.
+
diff --git a/docs/gitbook/api/bullmq.worker.ispaused.md b/docs/gitbook/api/bullmq.worker.ispaused.md
@@ -4,6 +4,8 @@
 
 ## Worker.isPaused() method
 
+Checks if worker is paused.
+
 <b>Signature:</b>
 
 ```typescript
@@ -13,3 +15,5 @@ isPaused(): boolean;
 
 boolean
 
+true if worker is paused, false otherwise.
+
diff --git a/docs/gitbook/api/bullmq.worker.isrunning.md b/docs/gitbook/api/bullmq.worker.isrunning.md
@@ -4,6 +4,8 @@
 
 ## Worker.isRunning() method
 
+Checks if worker is currently running.
+
 <b>Signature:</b>
 
 ```typescript
@@ -13,3 +15,5 @@ isRunning(): boolean;
 
 boolean
 
+true if worker is running, false otherwise.
+
diff --git a/docs/gitbook/api/bullmq.worker.resume.md b/docs/gitbook/api/bullmq.worker.resume.md
@@ -4,6 +4,8 @@
 
 ## Worker.resume() method
 
+Resumes processing of this worker (if paused).
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.worker.waituntilready.md b/docs/gitbook/api/bullmq.worker.waituntilready.md
@@ -4,6 +4,8 @@
 
 ## Worker.waitUntilReady() method
 
+Waits until the worker is ready to start processing jobs. In general only useful when writing tests.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.workeroptions.md b/docs/gitbook/api/bullmq.workeroptions.md
@@ -20,6 +20,7 @@ export interface WorkerOptions extends QueueBaseOptions
 |  [limiter?](./bullmq.workeroptions.limiter.md) | [RateLimiterOptions](./bullmq.ratelimiteroptions.md) | <i>(Optional)</i> |
 |  [lockDuration?](./bullmq.workeroptions.lockduration.md) | number | <i>(Optional)</i> |
 |  [lockRenewTime?](./bullmq.workeroptions.lockrenewtime.md) | number | <i>(Optional)</i> |
+|  [runRetryDelay?](./bullmq.workeroptions.runretrydelay.md) | number | <i>(Optional)</i> |
 |  [settings?](./bullmq.workeroptions.settings.md) | [AdvancedOptions](./bullmq.advancedoptions.md) | <i>(Optional)</i> |
 |  [skipDelayCheck?](./bullmq.workeroptions.skipdelaycheck.md) | boolean | <i>(Optional)</i> |
 
diff --git a/docs/gitbook/api/bullmq.workeroptions.runretrydelay.md b/docs/gitbook/api/bullmq.workeroptions.runretrydelay.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; [WorkerOptions](./bullmq.workeroptions.md) &gt; [runRetryDelay](./bullmq.workeroptions.runretrydelay.md)
+
+## WorkerOptions.runRetryDelay property
+
+<b>Signature:</b>
+
+```typescript
+runRetryDelay?: number;
+```
diff --git a/docs/gitbook/changelog.md b/docs/gitbook/changelog.md
@@ -1,3 +1,10 @@
+# [1.40.0](https://github.com/taskforcesh/bullmq/compare/v1.39.5...v1.40.0) (2021-07-22)
+
+
+### Features
+
+* **worker:** retry with delay errors in run loop ([409fe7f](https://github.com/taskforcesh/bullmq/commit/409fe7fc09b87b7916a3362a463bb9e0f17ecea8))
+
 ## [1.39.5](https://github.com/taskforcesh/bullmq/compare/v1.39.4...v1.39.5) (2021-07-21)
 
 ### Bug Fixes
@@ -871,4 +878,3 @@
 * Introduced animals into the world, we believe they're going to be a neat addition.
 
 #### 4.0.0-beta.0
-
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "bullmq",
-  "version": "1.39.5",
+  "version": "1.40.0",
   "description": "Queue for messages and jobs based on Redis",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",