-
Notifications
You must be signed in to change notification settings - Fork 440
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
# [1.13.0](v1.12.3...v1.13.0) (2020-12-30) ### Features * add support for manually processing jobs fixes [#327](#327) ([e42bfd2](e42bfd2)) yarn run v1.22.5 $ (api-extractor run || true) && api-documenter markdown -i ./temp -o docs/gitbook/api api-extractor 7.12.1 - https://api-extractor.com/ Using configuration from ./config/api-extractor.json Analysis will use the bundled TypeScript version 4.0.5 API Extractor completed with warnings api-documenter 7.12.1 - https://api-extractor.com/ Reading bullmq.api.json Deleting old output from docs/gitbook/api Writing bullmq package Done in 4.57s.
- Loading branch information
1 parent
6731f8a
commit 57b37ea
Showing
257 changed files
with
4,685 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 changes: 11 additions & 0 deletions
11
docs/gitbook/api/bullmq.advancedoptions.backoffstrategies.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [bullmq](./bullmq.md) > [AdvancedOptions](./bullmq.advancedoptions.md) > [backoffStrategies](./bullmq.advancedoptions.backoffstrategies.md) | ||
|
||
## AdvancedOptions.backoffStrategies property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
backoffStrategies?: {}; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [bullmq](./bullmq.md) > [AdvancedOptions](./bullmq.advancedoptions.md) | ||
|
||
## AdvancedOptions interface | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface AdvancedOptions | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [backoffStrategies?](./bullmq.advancedoptions.backoffstrategies.md) | {} | <i>(Optional)</i> | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [bullmq](./bullmq.md) > [AdvancedOptionsDefaults](./bullmq.advancedoptionsdefaults.md) | ||
|
||
## AdvancedOptionsDefaults variable | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
AdvancedOptionsDefaults: AdvancedOptions | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [bullmq](./bullmq.md) > [BackoffFunction](./bullmq.backofffunction.md) | ||
|
||
## BackoffFunction type | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare type BackoffFunction = (attemptsMade?: number, err?: Error) => number; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [bullmq](./bullmq.md) > [BackoffOptions](./bullmq.backoffoptions.md) > [delay](./bullmq.backoffoptions.delay.md) | ||
|
||
## BackoffOptions.delay property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
delay?: number; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [bullmq](./bullmq.md) > [BackoffOptions](./bullmq.backoffoptions.md) | ||
|
||
## BackoffOptions interface | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface BackoffOptions | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [delay?](./bullmq.backoffoptions.delay.md) | number | <i>(Optional)</i> | | ||
| [type](./bullmq.backoffoptions.type.md) | string | | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [bullmq](./bullmq.md) > [BackoffOptions](./bullmq.backoffoptions.md) > [type](./bullmq.backoffoptions.type.md) | ||
|
||
## BackoffOptions.type property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
type: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [bullmq](./bullmq.md) > [Backoffs](./bullmq.backoffs.md) > [builtinStrategies](./bullmq.backoffs.builtinstrategies.md) | ||
|
||
## Backoffs.builtinStrategies property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
static builtinStrategies: BuiltInStrategies; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [bullmq](./bullmq.md) > [Backoffs](./bullmq.backoffs.md) > [calculate](./bullmq.backoffs.calculate.md) | ||
|
||
## Backoffs.calculate() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
static calculate(backoff: BackoffOptions, attemptsMade: number, customStrategies: Strategies, err: Error): number; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| backoff | [BackoffOptions](./bullmq.backoffoptions.md) | | | ||
| attemptsMade | number | | | ||
| customStrategies | [Strategies](./bullmq.strategies.md) | | | ||
| err | Error | | | ||
|
||
<b>Returns:</b> | ||
|
||
number | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [bullmq](./bullmq.md) > [Backoffs](./bullmq.backoffs.md) | ||
|
||
## Backoffs class | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare class Backoffs | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Modifiers | Type | Description | | ||
| --- | --- | --- | --- | | ||
| [builtinStrategies](./bullmq.backoffs.builtinstrategies.md) | <code>static</code> | BuiltInStrategies | | | ||
|
||
## Methods | ||
|
||
| Method | Modifiers | Description | | ||
| --- | --- | --- | | ||
| [calculate(backoff, attemptsMade, customStrategies, err)](./bullmq.backoffs.calculate.md) | <code>static</code> | | | ||
| [normalize(backoff)](./bullmq.backoffs.normalize.md) | <code>static</code> | | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [bullmq](./bullmq.md) > [Backoffs](./bullmq.backoffs.md) > [normalize](./bullmq.backoffs.normalize.md) | ||
|
||
## Backoffs.normalize() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
static normalize(backoff: number | BackoffOptions): BackoffOptions; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| backoff | number \| [BackoffOptions](./bullmq.backoffoptions.md) | | | ||
|
||
<b>Returns:</b> | ||
|
||
[BackoffOptions](./bullmq.backoffoptions.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [bullmq](./bullmq.md) > [ChildPool](./bullmq.childpool.md) > [(constructor)](./bullmq.childpool._constructor_.md) | ||
|
||
## ChildPool.(constructor) | ||
|
||
Constructs a new instance of the `ChildPool` class | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
constructor(); | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [bullmq](./bullmq.md) > [ChildPool](./bullmq.childpool.md) > [clean](./bullmq.childpool.clean.md) | ||
|
||
## ChildPool.clean() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
clean(): Promise<void>; | ||
``` | ||
<b>Returns:</b> | ||
|
||
Promise<void> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [bullmq](./bullmq.md) > [ChildPool](./bullmq.childpool.md) > [free](./bullmq.childpool.free.md) | ||
|
||
## ChildPool.free property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
free: { | ||
[key: string]: ChildProcessExt[]; | ||
}; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [bullmq](./bullmq.md) > [ChildPool](./bullmq.childpool.md) > [getAllFree](./bullmq.childpool.getallfree.md) | ||
|
||
## ChildPool.getAllFree() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
getAllFree(): ChildProcessExt[]; | ||
``` | ||
<b>Returns:</b> | ||
|
||
[ChildProcessExt](./bullmq.childprocessext.md)<!-- -->\[\] | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [bullmq](./bullmq.md) > [ChildPool](./bullmq.childpool.md) > [getFree](./bullmq.childpool.getfree.md) | ||
|
||
## ChildPool.getFree() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
getFree(id: string): ChildProcessExt[]; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| id | string | | | ||
|
||
<b>Returns:</b> | ||
|
||
[ChildProcessExt](./bullmq.childprocessext.md)<!-- -->\[\] | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [bullmq](./bullmq.md) > [ChildPool](./bullmq.childpool.md) > [kill](./bullmq.childpool.kill.md) | ||
|
||
## ChildPool.kill() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
kill(child: ChildProcess, signal?: 'SIGTERM' | 'SIGKILL'): Promise<void>; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| child | ChildProcess | | | ||
| signal | 'SIGTERM' \| 'SIGKILL' | | | ||
|
||
<b>Returns:</b> | ||
|
||
Promise<void> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [bullmq](./bullmq.md) > [ChildPool](./bullmq.childpool.md) | ||
|
||
## ChildPool class | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare class ChildPool | ||
``` | ||
|
||
## Constructors | ||
|
||
| Constructor | Modifiers | Description | | ||
| --- | --- | --- | | ||
| [(constructor)()](./bullmq.childpool._constructor_.md) | | Constructs a new instance of the <code>ChildPool</code> class | | ||
|
||
## Properties | ||
|
||
| Property | Modifiers | Type | Description | | ||
| --- | --- | --- | --- | | ||
| [free](./bullmq.childpool.free.md) | | { \[key: string\]: [ChildProcessExt](./bullmq.childprocessext.md)<!-- -->\[\]; } | | | ||
| [retained](./bullmq.childpool.retained.md) | | { \[key: number\]: [ChildProcessExt](./bullmq.childprocessext.md)<!-- -->; } | | | ||
|
||
## Methods | ||
|
||
| Method | Modifiers | Description | | ||
| --- | --- | --- | | ||
| [clean()](./bullmq.childpool.clean.md) | | | | ||
| [getAllFree()](./bullmq.childpool.getallfree.md) | | | | ||
| [getFree(id)](./bullmq.childpool.getfree.md) | | | | ||
| [kill(child, signal)](./bullmq.childpool.kill.md) | | | | ||
| [release(child)](./bullmq.childpool.release.md) | | | | ||
| [remove(child)](./bullmq.childpool.remove.md) | | | | ||
| [retain(processFile)](./bullmq.childpool.retain.md) | | | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [bullmq](./bullmq.md) > [ChildPool](./bullmq.childpool.md) > [release](./bullmq.childpool.release.md) | ||
|
||
## ChildPool.release() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
release(child: ChildProcessExt): void; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| child | [ChildProcessExt](./bullmq.childprocessext.md) | | | ||
|
||
<b>Returns:</b> | ||
|
||
void | ||
|
Oops, something went wrong.