Skip to content

Conversation

@clawrence121
Copy link
Contributor

@clawrence121 clawrence121 commented Aug 8, 2024

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Docs
  • Other... Please describe:

What is the current behavior?

The existing documentation was not updated correctly for the newer BullMQ package, and does not cover all use cases provided by the new package.

Issue Number: N/A

What is the new behavior?

Docs updated to work with BullMQ.

This matches the documentation that is found in the official BullMQ docs:
https://docs.bullmq.io/guide/nestjs#processor
https://docs.bullmq.io/guide/nestjs/queue-events-listeners

As well as the code behaviour and comments:
https://github.com/nestjs/bull/blob/master/packages/bullmq/lib/decorators/on-worker-event.decorator.ts
https://github.com/nestjs/bull/blob/master/packages/bullmq/lib/decorators/on-queue-event.decorator.ts

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@clawrence121 clawrence121 force-pushed the fix-bullmq-event-listener-documentation branch from 939889c to a697ac7 Compare August 8, 2024 15:57
@clawrence121 clawrence121 force-pushed the fix-bullmq-event-listener-documentation branch from a697ac7 to 9513bd4 Compare August 8, 2024 16:05
@kamilmysliwiec
Copy link
Member

LGTM

@kamilmysliwiec kamilmysliwiec merged commit 5f68f37 into nestjs:master Aug 9, 2024
@kamilmysliwiec
Copy link
Member

Thanks!

@clawrence121 clawrence121 deleted the fix-bullmq-event-listener-documentation branch August 9, 2024 07:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants