diff --git a/docs/gitbook/api/bullmq.md b/docs/gitbook/api/bullmq.md index 4e3eb2ffb0..0ca6feceba 100644 --- 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 index c1aa286c50..7d3faa6aa2 100644 --- 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. + Signature: ```typescript @@ -14,9 +18,11 @@ close(force?: boolean): Promise; | Parameter | Type | Description | | --- | --- | --- | -| force | boolean | | +| force | boolean | Use force boolean parameter if you do not want to wait for current jobs to be processed. | Returns: Promise<void> +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 index 4f855612e1..d696d32251 100644 --- 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. + Signature: ```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 index 44f24e1276..b7268df52b 100644 --- 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. + Signature: ```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 index 63c9543c55..24350f74dc 100644 --- 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). + Signature: ```typescript diff --git a/docs/gitbook/api/bullmq.worker.waituntilready.md b/docs/gitbook/api/bullmq.worker.waituntilready.md index 51ed798744..914748ab1e 100644 --- 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. + Signature: ```typescript diff --git a/docs/gitbook/api/bullmq.workeroptions.md b/docs/gitbook/api/bullmq.workeroptions.md index 053bc19130..53bf2a514a 100644 --- 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) | (Optional) | | [lockDuration?](./bullmq.workeroptions.lockduration.md) | number | (Optional) | | [lockRenewTime?](./bullmq.workeroptions.lockrenewtime.md) | number | (Optional) | +| [runRetryDelay?](./bullmq.workeroptions.runretrydelay.md) | number | (Optional) | | [settings?](./bullmq.workeroptions.settings.md) | [AdvancedOptions](./bullmq.advancedoptions.md) | (Optional) | | [skipDelayCheck?](./bullmq.workeroptions.skipdelaycheck.md) | boolean | (Optional) | diff --git a/docs/gitbook/api/bullmq.workeroptions.runretrydelay.md b/docs/gitbook/api/bullmq.workeroptions.runretrydelay.md new file mode 100644 index 0000000000..6e2a0bc15c --- /dev/null +++ b/docs/gitbook/api/bullmq.workeroptions.runretrydelay.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bullmq](./bullmq.md) > [WorkerOptions](./bullmq.workeroptions.md) > [runRetryDelay](./bullmq.workeroptions.runretrydelay.md) + +## WorkerOptions.runRetryDelay property + +Signature: + +```typescript +runRetryDelay?: number; +``` diff --git a/docs/gitbook/changelog.md b/docs/gitbook/changelog.md index 5a885b5780..e6d2346259 100644 --- 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 index e136a36f71..7823a928f4 100644 --- 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",