From dcb5f5b12b133a60b4ed09cc083915187c84ed2d Mon Sep 17 00:00:00 2001 From: semantic-release-bot Date: Fri, 16 Apr 2021 05:24:04 +0000 Subject: [PATCH] chore(release): 1.17.0 [skip ci] # [1.17.0](https://github.com/taskforcesh/bullmq/compare/v1.16.2...v1.17.0) (2021-04-16) ### Features * **job:** consider waiting-children state ([2916dd5](https://github.com/taskforcesh/bullmq/commit/2916dd5d7ba9438d2eae66436899d32ec8ac0e91)) --- docs/gitbook/CHANGELOG.md | 7 +++++++ docs/gitbook/api/bullmq.job.getdependencies.md | 4 ++-- docs/gitbook/api/bullmq.job.iswaitingchildren.md | 15 +++++++++++++++ docs/gitbook/api/bullmq.job.md | 1 + package.json | 2 +- 5 files changed, 26 insertions(+), 3 deletions(-) create mode 100644 docs/gitbook/api/bullmq.job.iswaitingchildren.md diff --git a/docs/gitbook/CHANGELOG.md b/docs/gitbook/CHANGELOG.md index 4e55b47a61..b2a424e9c5 100644 --- a/docs/gitbook/CHANGELOG.md +++ b/docs/gitbook/CHANGELOG.md @@ -1,3 +1,10 @@ +# [1.17.0](https://github.com/taskforcesh/bullmq/compare/v1.16.2...v1.17.0) (2021-04-16) + + +### Features + +* **job:** consider waiting-children state ([2916dd5](https://github.com/taskforcesh/bullmq/commit/2916dd5d7ba9438d2eae66436899d32ec8ac0e91)) + ## [1.16.2](https://github.com/taskforcesh/bullmq/compare/v1.16.1...v1.16.2) (2021-04-14) diff --git a/docs/gitbook/api/bullmq.job.getdependencies.md b/docs/gitbook/api/bullmq.job.getdependencies.md index 33f85d9022..8088403265 100644 --- a/docs/gitbook/api/bullmq.job.getdependencies.md +++ b/docs/gitbook/api/bullmq.job.getdependencies.md @@ -11,12 +11,12 @@ Get children job keys if this job is a parent and has children. ```typescript getDependencies(): Promise<{ processed: string[]; - unprocessed: any; + unprocessed: object; }>; ``` Returns: -Promise<{ processed: string\[\]; unprocessed: any; }> +Promise<{ processed: string\[\]; unprocessed: object; }> dependencies separated by processed and unprocessed. diff --git a/docs/gitbook/api/bullmq.job.iswaitingchildren.md b/docs/gitbook/api/bullmq.job.iswaitingchildren.md new file mode 100644 index 0000000000..c84eb5250e --- /dev/null +++ b/docs/gitbook/api/bullmq.job.iswaitingchildren.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [bullmq](./bullmq.md) > [Job](./bullmq.job.md) > [isWaitingChildren](./bullmq.job.iswaitingchildren.md) + +## Job.isWaitingChildren() method + +Signature: + +```typescript +isWaitingChildren(): Promise; +``` +Returns: + +Promise<boolean> + diff --git a/docs/gitbook/api/bullmq.job.md b/docs/gitbook/api/bullmq.job.md index 04db9df325..756e6c749f 100644 --- a/docs/gitbook/api/bullmq.job.md +++ b/docs/gitbook/api/bullmq.job.md @@ -53,6 +53,7 @@ export declare class Job | [isDelayed()](./bullmq.job.isdelayed.md) | | | | [isFailed()](./bullmq.job.isfailed.md) | | | | [isWaiting()](./bullmq.job.iswaiting.md) | | | +| [isWaitingChildren()](./bullmq.job.iswaitingchildren.md) | | | | [log(logRow)](./bullmq.job.log.md) | | Logs one row of log data. logRow: string String with log data to be logged. | | [moveToCompleted(returnValue, token, fetchNext)](./bullmq.job.movetocompleted.md) | | Moves a job to the completed queue. Returned job to be used with Queue.prototype.nextJobFromJobData. | | [moveToDelayed(timestamp)](./bullmq.job.movetodelayed.md) | | | diff --git a/package.json b/package.json index 47a5a6f5d1..1e706d5ced 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "bullmq", - "version": "1.16.2", + "version": "1.17.0", "description": "Queue for messages and jobs based on Redis", "main": "dist/index.js", "types": "dist/index.d.ts",