Skip to content

Commit

Permalink
chore(release): 1.13.0 [skip ci]
Browse files Browse the repository at this point in the history
# [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
semantic-release-bot committed Dec 30, 2020
1 parent 6731f8a commit 57b37ea
Show file tree
Hide file tree
Showing 257 changed files with 4,685 additions and 1 deletion.
29 changes: 29 additions & 0 deletions docs/gitbook/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,32 @@
# [1.13.0](https://github.com/taskforcesh/bullmq/compare/v1.12.3...v1.13.0) (2020-12-30)


### Features

* add support for manually processing jobs fixes [#327](https://github.com/taskforcesh/bullmq/issues/327) ([e42bfd2](https://github.com/taskforcesh/bullmq/commit/e42bfd2814fc5136b175470c3085355090cc2e01))





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.

## [1.12.3](https://github.com/taskforcesh/bullmq/compare/v1.12.2...v1.12.3) (2020-12-28)


Expand Down
11 changes: 11 additions & 0 deletions docs/gitbook/api/bullmq.advancedoptions.backoffstrategies.md
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) &gt; [bullmq](./bullmq.md) &gt; [AdvancedOptions](./bullmq.advancedoptions.md) &gt; [backoffStrategies](./bullmq.advancedoptions.backoffstrategies.md)

## AdvancedOptions.backoffStrategies property

<b>Signature:</b>

```typescript
backoffStrategies?: {};
```
18 changes: 18 additions & 0 deletions docs/gitbook/api/bullmq.advancedoptions.md
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) &gt; [bullmq](./bullmq.md) &gt; [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> |

11 changes: 11 additions & 0 deletions docs/gitbook/api/bullmq.advancedoptionsdefaults.md
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) &gt; [bullmq](./bullmq.md) &gt; [AdvancedOptionsDefaults](./bullmq.advancedoptionsdefaults.md)

## AdvancedOptionsDefaults variable

<b>Signature:</b>

```typescript
AdvancedOptionsDefaults: AdvancedOptions
```
11 changes: 11 additions & 0 deletions docs/gitbook/api/bullmq.backofffunction.md
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) &gt; [bullmq](./bullmq.md) &gt; [BackoffFunction](./bullmq.backofffunction.md)

## BackoffFunction type

<b>Signature:</b>

```typescript
export declare type BackoffFunction = (attemptsMade?: number, err?: Error) => number;
```
11 changes: 11 additions & 0 deletions docs/gitbook/api/bullmq.backoffoptions.delay.md
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) &gt; [bullmq](./bullmq.md) &gt; [BackoffOptions](./bullmq.backoffoptions.md) &gt; [delay](./bullmq.backoffoptions.delay.md)

## BackoffOptions.delay property

<b>Signature:</b>

```typescript
delay?: number;
```
19 changes: 19 additions & 0 deletions docs/gitbook/api/bullmq.backoffoptions.md
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) &gt; [bullmq](./bullmq.md) &gt; [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 | |

11 changes: 11 additions & 0 deletions docs/gitbook/api/bullmq.backoffoptions.type.md
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) &gt; [bullmq](./bullmq.md) &gt; [BackoffOptions](./bullmq.backoffoptions.md) &gt; [type](./bullmq.backoffoptions.type.md)

## BackoffOptions.type property

<b>Signature:</b>

```typescript
type: string;
```
11 changes: 11 additions & 0 deletions docs/gitbook/api/bullmq.backoffs.builtinstrategies.md
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) &gt; [bullmq](./bullmq.md) &gt; [Backoffs](./bullmq.backoffs.md) &gt; [builtinStrategies](./bullmq.backoffs.builtinstrategies.md)

## Backoffs.builtinStrategies property

<b>Signature:</b>

```typescript
static builtinStrategies: BuiltInStrategies;
```
25 changes: 25 additions & 0 deletions docs/gitbook/api/bullmq.backoffs.calculate.md
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) &gt; [bullmq](./bullmq.md) &gt; [Backoffs](./bullmq.backoffs.md) &gt; [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

25 changes: 25 additions & 0 deletions docs/gitbook/api/bullmq.backoffs.md
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) &gt; [bullmq](./bullmq.md) &gt; [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> | |

22 changes: 22 additions & 0 deletions docs/gitbook/api/bullmq.backoffs.normalize.md
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) &gt; [bullmq](./bullmq.md) &gt; [Backoffs](./bullmq.backoffs.md) &gt; [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)

13 changes: 13 additions & 0 deletions docs/gitbook/api/bullmq.childpool._constructor_.md
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) &gt; [bullmq](./bullmq.md) &gt; [ChildPool](./bullmq.childpool.md) &gt; [(constructor)](./bullmq.childpool._constructor_.md)

## ChildPool.(constructor)

Constructs a new instance of the `ChildPool` class

<b>Signature:</b>

```typescript
constructor();
```
15 changes: 15 additions & 0 deletions docs/gitbook/api/bullmq.childpool.clean.md
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) &gt; [bullmq](./bullmq.md) &gt; [ChildPool](./bullmq.childpool.md) &gt; [clean](./bullmq.childpool.clean.md)

## ChildPool.clean() method

<b>Signature:</b>

```typescript
clean(): Promise<void>;
```
<b>Returns:</b>

Promise&lt;void&gt;

13 changes: 13 additions & 0 deletions docs/gitbook/api/bullmq.childpool.free.md
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) &gt; [bullmq](./bullmq.md) &gt; [ChildPool](./bullmq.childpool.md) &gt; [free](./bullmq.childpool.free.md)

## ChildPool.free property

<b>Signature:</b>

```typescript
free: {
[key: string]: ChildProcessExt[];
};
```
15 changes: 15 additions & 0 deletions docs/gitbook/api/bullmq.childpool.getallfree.md
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) &gt; [bullmq](./bullmq.md) &gt; [ChildPool](./bullmq.childpool.md) &gt; [getAllFree](./bullmq.childpool.getallfree.md)

## ChildPool.getAllFree() method

<b>Signature:</b>

```typescript
getAllFree(): ChildProcessExt[];
```
<b>Returns:</b>

[ChildProcessExt](./bullmq.childprocessext.md)<!-- -->\[\]

22 changes: 22 additions & 0 deletions docs/gitbook/api/bullmq.childpool.getfree.md
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) &gt; [bullmq](./bullmq.md) &gt; [ChildPool](./bullmq.childpool.md) &gt; [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)<!-- -->\[\]

23 changes: 23 additions & 0 deletions docs/gitbook/api/bullmq.childpool.kill.md
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) &gt; [bullmq](./bullmq.md) &gt; [ChildPool](./bullmq.childpool.md) &gt; [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&lt;void&gt;

37 changes: 37 additions & 0 deletions docs/gitbook/api/bullmq.childpool.md
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) &gt; [bullmq](./bullmq.md) &gt; [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) | | |

22 changes: 22 additions & 0 deletions docs/gitbook/api/bullmq.childpool.release.md
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) &gt; [bullmq](./bullmq.md) &gt; [ChildPool](./bullmq.childpool.md) &gt; [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

Loading

0 comments on commit 57b37ea

Please sign in to comment.