Skip to content

Commit b43431c

Browse files
chore(release): 1.18.1 [skip ci]
## [1.18.1](v1.18.0...v1.18.1) (2021-04-16) ### Bug Fixes * rename Flow to FlowProducer class ([c64321d](c64321d))
1 parent c64321d commit b43431c

22 files changed

+137
-130
lines changed

docs/gitbook/CHANGELOG.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
## [1.18.1](https://github.com/taskforcesh/bullmq/compare/v1.18.0...v1.18.1) (2021-04-16)
2+
3+
4+
### Bug Fixes
5+
6+
* rename Flow to FlowProducer class ([c64321d](https://github.com/taskforcesh/bullmq/commit/c64321d03e2af7cee88eaf6df6cd2e5b7840ae64))
7+
18
# [1.18.0](https://github.com/taskforcesh/bullmq/compare/v1.17.0...v1.18.0) (2021-04-16)
29

310

docs/gitbook/api/bullmq.flow.closing.md

-11
This file was deleted.

docs/gitbook/api/bullmq.flow.connection.md

-11
This file was deleted.

docs/gitbook/api/bullmq.flow.disconnect.md

-15
This file was deleted.

docs/gitbook/api/bullmq.flow.keys.md

-11
This file was deleted.

docs/gitbook/api/bullmq.flow.md

-40
This file was deleted.

docs/gitbook/api/bullmq.flow.opts.md

-11
This file was deleted.

docs/gitbook/api/bullmq.flow.queuekeys.md

-11
This file was deleted.

docs/gitbook/api/bullmq.flow.tokey.md

-11
This file was deleted.

docs/gitbook/api/bullmq.flow._constructor_.md docs/gitbook/api/bullmq.flowproducer._constructor_.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [bullmq](./bullmq.md) &gt; [Flow](./bullmq.flow.md) &gt; [(constructor)](./bullmq.flow._constructor_.md)
3+
[Home](./index.md) &gt; [bullmq](./bullmq.md) &gt; [FlowProducer](./bullmq.flowproducer.md) &gt; [(constructor)](./bullmq.flowproducer._constructor_.md)
44

5-
## Flow.(constructor)
5+
## FlowProducer.(constructor)
66

7-
Constructs a new instance of the `Flow` class
7+
Constructs a new instance of the `FlowProducer` class
88

99
<b>Signature:</b>
1010

docs/gitbook/api/bullmq.flow.add.md docs/gitbook/api/bullmq.flowproducer.add.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [bullmq](./bullmq.md) &gt; [Flow](./bullmq.flow.md) &gt; [add](./bullmq.flow.add.md)
3+
[Home](./index.md) &gt; [bullmq](./bullmq.md) &gt; [FlowProducer](./bullmq.flowproducer.md) &gt; [add](./bullmq.flowproducer.add.md)
44

5-
## Flow.add() method
5+
## FlowProducer.add() method
66

77
Adds a flow.
88

docs/gitbook/api/bullmq.flow.close.md docs/gitbook/api/bullmq.flowproducer.close.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [bullmq](./bullmq.md) &gt; [Flow](./bullmq.flow.md) &gt; [close](./bullmq.flow.close.md)
3+
[Home](./index.md) &gt; [bullmq](./bullmq.md) &gt; [FlowProducer](./bullmq.flowproducer.md) &gt; [close](./bullmq.flowproducer.close.md)
44

5-
## Flow.close() method
5+
## FlowProducer.close() method
66

77
<b>Signature:</b>
88

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [bullmq](./bullmq.md) &gt; [FlowProducer](./bullmq.flowproducer.md) &gt; [closing](./bullmq.flowproducer.closing.md)
4+
5+
## FlowProducer.closing property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
closing: Promise<void>;
11+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [bullmq](./bullmq.md) &gt; [FlowProducer](./bullmq.flowproducer.md) &gt; [connection](./bullmq.flowproducer.connection.md)
4+
5+
## FlowProducer.connection property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
protected connection: RedisConnection;
11+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [bullmq](./bullmq.md) &gt; [FlowProducer](./bullmq.flowproducer.md) &gt; [disconnect](./bullmq.flowproducer.disconnect.md)
4+
5+
## FlowProducer.disconnect() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
disconnect(): Promise<void>;
11+
```
12+
<b>Returns:</b>
13+
14+
Promise&lt;void&gt;
15+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [bullmq](./bullmq.md) &gt; [FlowProducer](./bullmq.flowproducer.md) &gt; [keys](./bullmq.flowproducer.keys.md)
4+
5+
## FlowProducer.keys property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
keys: KeysMap;
11+
```
+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [bullmq](./bullmq.md) &gt; [FlowProducer](./bullmq.flowproducer.md)
4+
5+
## FlowProducer class
6+
7+
This class allows to add jobs into one or several queues with dependencies between them in such a way that it is possible to build complex flows.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export declare class FlowProducer extends EventEmitter
13+
```
14+
<b>Extends:</b> EventEmitter
15+
16+
## Constructors
17+
18+
| Constructor | Modifiers | Description |
19+
| --- | --- | --- |
20+
| [(constructor)(opts)](./bullmq.flowproducer._constructor_.md) | | Constructs a new instance of the <code>FlowProducer</code> class |
21+
22+
## Properties
23+
24+
| Property | Modifiers | Type | Description |
25+
| --- | --- | --- | --- |
26+
| [closing](./bullmq.flowproducer.closing.md) | | Promise&lt;void&gt; | |
27+
| [connection](./bullmq.flowproducer.connection.md) | | [RedisConnection](./bullmq.redisconnection.md) | |
28+
| [keys](./bullmq.flowproducer.keys.md) | | KeysMap | |
29+
| [opts](./bullmq.flowproducer.opts.md) | | [QueueBaseOptions](./bullmq.queuebaseoptions.md) | |
30+
| [queueKeys](./bullmq.flowproducer.queuekeys.md) | | QueueKeys | |
31+
| [toKey](./bullmq.flowproducer.tokey.md) | | (name: string, type: string) =&gt; string | |
32+
33+
## Methods
34+
35+
| Method | Modifiers | Description |
36+
| --- | --- | --- |
37+
| [add(flow)](./bullmq.flowproducer.add.md) | | Adds a flow.<!-- -->A flow is a tree-like structure of jobs that depend on each other. Whenever the children of a given parent are completed, the parent will be processed, being able to access the children's result data.<!-- -->All Jobs can be in different queues, either children or parents, however this call would be atomic, either it fails and no jobs will be added to the queues, or it succeeds and all jobs will be added. |
38+
| [close()](./bullmq.flowproducer.close.md) | | |
39+
| [disconnect()](./bullmq.flowproducer.disconnect.md) | | |
40+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [bullmq](./bullmq.md) &gt; [FlowProducer](./bullmq.flowproducer.md) &gt; [opts](./bullmq.flowproducer.opts.md)
4+
5+
## FlowProducer.opts property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
opts: QueueBaseOptions;
11+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [bullmq](./bullmq.md) &gt; [FlowProducer](./bullmq.flowproducer.md) &gt; [queueKeys](./bullmq.flowproducer.queuekeys.md)
4+
5+
## FlowProducer.queueKeys property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
queueKeys: QueueKeys;
11+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [bullmq](./bullmq.md) &gt; [FlowProducer](./bullmq.flowproducer.md) &gt; [toKey](./bullmq.flowproducer.tokey.md)
4+
5+
## FlowProducer.toKey property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
toKey: (name: string, type: string) => string;
11+
```

docs/gitbook/api/bullmq.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
| --- | --- |
1111
| [Backoffs](./bullmq.backoffs.md) | |
1212
| [ChildPool](./bullmq.childpool.md) | |
13-
| [Flow](./bullmq.flow.md) | This class allows to add jobs into one or several queues with dependencies between them in such a way that it is possible to build complex flows. |
13+
| [FlowProducer](./bullmq.flowproducer.md) | This class allows to add jobs into one or several queues with dependencies between them in such a way that it is possible to build complex flows. |
1414
| [Job](./bullmq.job.md) | |
1515
| [Queue](./bullmq.queue.md) | |
1616
| [QueueBase](./bullmq.queuebase.md) | |

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "bullmq",
3-
"version": "1.18.0",
3+
"version": "1.18.1",
44
"description": "Queue for messages and jobs based on Redis",
55
"main": "dist/index.js",
66
"types": "dist/index.d.ts",

0 commit comments

Comments
 (0)