Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(nestjs-bullmq-pro): add queue events listeners section #2138

Merged
merged 3 commits into from
Aug 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/gitbook/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@
* [Batches](bullmq-pro/batches.md)
* [NestJs](bullmq-pro/nestjs/README.md)
* [Producers](bullmq-pro/nestjs/producers.md)
* [Queue Events Listeners](bullmq-pro/nestjs/queue-events-listeners.md)
* [API Reference](https://nestjs.bullmq.pro/)
* [Changelog](bullmq-pro/nestjs/changelog.md)
* [API Reference](https://api.bullmq.pro)
Expand Down
1 change: 1 addition & 0 deletions docs/gitbook/bullmq-pro/nestjs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,3 +102,4 @@ A working example is available [here](https://github.com/taskforcesh/nestjs-bull
- 💡 [Queues Technique](https://docs.nestjs.com/techniques/queues)
- 💡 [Register Queue API Reference](https://nestjs.bullmq.pro/classes/BullModule.html#registerQueue)
- 💡 [Register Flow Producer API Reference](https://nestjs.bullmq.pro/classes/BullModule.html#registerFlowProducer)
- 💡 [Worker Listener API Reference](https://api.docs.bullmq.io/interfaces/v4.WorkerListener.html)
2 changes: 2 additions & 0 deletions docs/gitbook/bullmq-pro/nestjs/producers.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Producers

Job producers add jobs to queues. Producers are typically application services (Nest providers). To add jobs to a queue, first inject the queue into the service as follows:

```typescript
Expand Down
49 changes: 49 additions & 0 deletions docs/gitbook/bullmq-pro/nestjs/queue-events-listeners.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Queue Events Listeners

To register a QueueEvents instance, you need to use **QueueEventsListener** decorator:

```typescript
import {
QueueEventsListener,
QueueEventsHost,
OnQueueEvent,
} from '@taskforcesh/nestjs-bullmq-pro';

@QueueEventsListener('queueName')
export class TestQueueEvents extends QueueEventsHost {
@OnQueueEvent('completed')
onCompleted({
jobId,
}: {
jobId: string;
returnvalue: string;
prev?: string;
}) {
// do some stuff
}
}
```

And then register it as a provider:

```typescript
@Module({
imports: [
BullModule.registerQueue({
name: 'queueName',
connection: {
host: '0.0.0.0',
port: 6380,
},
}),
],
providers: [TestQueueEvents],
})
export class AppModule {}
```

## Read more:

- 💡 [Queues Technique](https://docs.nestjs.com/techniques/queues)
- 💡 [Register Queue API Reference](https://nestjs.bullmq.pro/classes/BullModule.html#registerQueue)
- 💡 [Queue Events Pro Listener API Reference](https://api.bullmq.pro/interfaces/v6.QueueEventsListenerPro.html)
Loading