Skip to content

Commit

Permalink
chore(release): 1.80.0 [skip ci]
Browse files Browse the repository at this point in the history
# [1.80.0](v1.79.1...v1.80.0) (2022-04-12)

### Features

* **worker-listener:** use generics in events ([#1190](#1190)) ref [#1188](#1188) ([2821193](2821193))
  • Loading branch information
semantic-release-bot committed Apr 12, 2022
1 parent 2821193 commit 3ac9dd0
Show file tree
Hide file tree
Showing 11 changed files with 25 additions and 18 deletions.
4 changes: 2 additions & 2 deletions docs/gitbook/api/bullmq.worker.emit.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
<b>Signature:</b>

```typescript
emit<U extends keyof WorkerListener>(event: U, ...args: Parameters<WorkerListener[U]>): boolean;
emit<U extends keyof WorkerListener<DataType, ResultType, NameType>>(event: U, ...args: Parameters<WorkerListener<DataType, ResultType, NameType>[U]>): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| event | U | |
| args | Parameters&lt;[WorkerListener](./bullmq.workerlistener.md)<!-- -->\[U\]&gt; | |
| args | Parameters&lt;[WorkerListener](./bullmq.workerlistener.md)<!-- -->&lt;DataType, ResultType, NameType&gt;\[U\]&gt; | |
<b>Returns:</b>
Expand Down
4 changes: 2 additions & 2 deletions docs/gitbook/api/bullmq.worker.off.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
<b>Signature:</b>

```typescript
off<U extends keyof WorkerListener>(eventName: U, listener: WorkerListener[U]): this;
off<U extends keyof WorkerListener<DataType, ResultType, NameType>>(eventName: U, listener: WorkerListener<DataType, ResultType, NameType>[U]): this;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| eventName | U | |
| listener | [WorkerListener](./bullmq.workerlistener.md)<!-- -->\[U\] | |
| listener | [WorkerListener](./bullmq.workerlistener.md)<!-- -->&lt;DataType, ResultType, NameType&gt;\[U\] | |
<b>Returns:</b>
Expand Down
4 changes: 2 additions & 2 deletions docs/gitbook/api/bullmq.worker.on.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
<b>Signature:</b>

```typescript
on<U extends keyof WorkerListener>(event: U, listener: WorkerListener[U]): this;
on<U extends keyof WorkerListener<DataType, ResultType, NameType>>(event: U, listener: WorkerListener<DataType, ResultType, NameType>[U]): this;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| event | U | |
| listener | [WorkerListener](./bullmq.workerlistener.md)<!-- -->\[U\] | |
| listener | [WorkerListener](./bullmq.workerlistener.md)<!-- -->&lt;DataType, ResultType, NameType&gt;\[U\] | |
<b>Returns:</b>
Expand Down
4 changes: 2 additions & 2 deletions docs/gitbook/api/bullmq.worker.once.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
<b>Signature:</b>

```typescript
once<U extends keyof WorkerListener>(event: U, listener: WorkerListener[U]): this;
once<U extends keyof WorkerListener<DataType, ResultType, NameType>>(event: U, listener: WorkerListener<DataType, ResultType, NameType>[U]): this;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| event | U | |
| listener | [WorkerListener](./bullmq.workerlistener.md)<!-- -->\[U\] | |
| listener | [WorkerListener](./bullmq.workerlistener.md)<!-- -->&lt;DataType, ResultType, NameType&gt;\[U\] | |
<b>Returns:</b>
Expand Down
2 changes: 1 addition & 1 deletion docs/gitbook/api/bullmq.workerlistener.active.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ This event is triggered when a job enters the 'active' state.
<b>Signature:</b>

```typescript
active: (job: Job, prev: string) => void;
active: (job: Job<DataType, ResultType, NameType>, prev: string) => void;
```
2 changes: 1 addition & 1 deletion docs/gitbook/api/bullmq.workerlistener.completed.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ This event is triggered when a job has successfully completed.
<b>Signature:</b>

```typescript
completed: (job: Job, result: any, prev: string) => void;
completed: (job: Job<DataType, ResultType, NameType>, result: ResultType, prev: string) => void;
```
2 changes: 1 addition & 1 deletion docs/gitbook/api/bullmq.workerlistener.failed.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ This event is triggered when a job has thrown an exception.
<b>Signature:</b>

```typescript
failed: (job: Job, error: Error, prev: string) => void;
failed: (job: Job<DataType, ResultType, NameType>, error: Error, prev: string) => void;
```
10 changes: 5 additions & 5 deletions docs/gitbook/api/bullmq.workerlistener.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,21 @@
<b>Signature:</b>

```typescript
export interface WorkerListener
export interface WorkerListener<DataType = any, ResultType = any, NameType extends string = string>
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [active](./bullmq.workerlistener.active.md) | (job: [Job](./bullmq.job.md)<!-- -->, prev: string) =&gt; void | Listen to 'active' event.<!-- -->This event is triggered when a job enters the 'active' state. |
| [active](./bullmq.workerlistener.active.md) | (job: [Job](./bullmq.job.md)<!-- -->&lt;DataType, ResultType, NameType&gt;, prev: string) =&gt; void | Listen to 'active' event.<!-- -->This event is triggered when a job enters the 'active' state. |
| [closed](./bullmq.workerlistener.closed.md) | () =&gt; void | Listen to 'closing' event.<!-- -->This event is triggered when the worker is closed. |
| [closing](./bullmq.workerlistener.closing.md) | (msg: string) =&gt; void | Listen to 'closing' event.<!-- -->This event is triggered when the worker is closing. |
| [completed](./bullmq.workerlistener.completed.md) | (job: [Job](./bullmq.job.md)<!-- -->, result: any, prev: string) =&gt; void | Listen to 'completed' event.<!-- -->This event is triggered when a job has successfully completed. |
| [completed](./bullmq.workerlistener.completed.md) | (job: [Job](./bullmq.job.md)<!-- -->&lt;DataType, ResultType, NameType&gt;, result: ResultType, prev: string) =&gt; void | Listen to 'completed' event.<!-- -->This event is triggered when a job has successfully completed. |
| [drained](./bullmq.workerlistener.drained.md) | () =&gt; void | Listen to 'drained' event.<!-- -->This event is triggered when the queue has drained the waiting list. Note that there could still be delayed jobs waiting their timers to expire and this event will still be triggered as long as the waiting list has emptied. |
| [error](./bullmq.workerlistener.error.md) | (failedReason: Error) =&gt; void | Listen to 'error' event.<!-- -->This event is triggered when an error is throw. |
| [failed](./bullmq.workerlistener.failed.md) | (job: [Job](./bullmq.job.md)<!-- -->, error: Error, prev: string) =&gt; void | Listen to 'failed' event.<!-- -->This event is triggered when a job has thrown an exception. |
| [failed](./bullmq.workerlistener.failed.md) | (job: [Job](./bullmq.job.md)<!-- -->&lt;DataType, ResultType, NameType&gt;, error: Error, prev: string) =&gt; void | Listen to 'failed' event.<!-- -->This event is triggered when a job has thrown an exception. |
| [paused](./bullmq.workerlistener.paused.md) | () =&gt; void | Listen to 'paused' event.<!-- -->This event is triggered when the queue is paused. |
| [progress](./bullmq.workerlistener.progress.md) | (job: [Job](./bullmq.job.md)<!-- -->, progress: number \| object) =&gt; void | Listen to 'progress' event.<!-- -->This event is triggered when a job updates it progress, i.e. the Job\#\#updateProgress() method is called. This is useful to notify progress or any other data from within a processor to the rest of the world. |
| [progress](./bullmq.workerlistener.progress.md) | (job: [Job](./bullmq.job.md)<!-- -->&lt;DataType, ResultType, NameType&gt;, progress: number \| object) =&gt; void | Listen to 'progress' event.<!-- -->This event is triggered when a job updates it progress, i.e. the Job\#\#updateProgress() method is called. This is useful to notify progress or any other data from within a processor to the rest of the world. |
| [resumed](./bullmq.workerlistener.resumed.md) | () =&gt; void | Listen to 'resumed' event.<!-- -->This event is triggered when the queue is resumed. |

2 changes: 1 addition & 1 deletion docs/gitbook/api/bullmq.workerlistener.progress.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ This event is triggered when a job updates it progress, i.e. the Job\#\#updatePr
<b>Signature:</b>

```typescript
progress: (job: Job, progress: number | object) => void;
progress: (job: Job<DataType, ResultType, NameType>, progress: number | object) => void;
```
7 changes: 7 additions & 0 deletions docs/gitbook/changelog.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# [1.80.0](https://github.com/taskforcesh/bullmq/compare/v1.79.1...v1.80.0) (2022-04-12)


### Features

* **worker-listener:** use generics in events ([#1190](https://github.com/taskforcesh/bullmq/issues/1190)) ref [#1188](https://github.com/taskforcesh/bullmq/issues/1188) ([2821193](https://github.com/taskforcesh/bullmq/commit/28211937d9ed405330eede5ad7d4b0b817accf39))

## [1.79.1](https://github.com/taskforcesh/bullmq/compare/v1.79.0...v1.79.1) (2022-04-12)


Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "bullmq",
"version": "1.79.1",
"version": "1.80.0",
"description": "Queue for messages and jobs based on Redis",
"main": "dist/cjs/index.js",
"module": "dist/esm/index.js",
Expand Down

0 comments on commit 3ac9dd0

Please sign in to comment.