This package has been migrated

This package has been migrated to the official bull-board repository and will be maintained from there.

Please use the official @bull-board/nestjs package for future support and maintenance.

NestJS bull-board module

A simple NestJS module for using bull-board with NestJS.

Installation

Install both @bull-board/api and this module.

1$ npm install --save nestjs-bull-board @bull-board/api

Install the Express or Fastify adapter depending on what you use in NestJS (default is Express)

1$ npm install --save @bull-board/express
2//or 
3$ npm install --save @bull-board/fastify

Register the root module

Once the installation is completed, we can import the BullBoardModule into your rootmodule e.g. AppModule.

1import { Module } from '@nestjs/common';
2import { BullBoardModule } from "nestjs-bull-board";
3import { ExpressAdapter } from "@bull-board/express";
4
5@Module({
6  imports: [
7    BullModule.forRoot({
8      // your bull module config here.
9    }),
10
11    BullBoardModule.forRoot({
12      route: '/queues',
13      adapter: ExpressAdapter // Or FastifyAdapter from `@bull-board/fastify`
14    }),
15  ],
16})
17export class AppModule {
18}

The forRoot() method registers the bull-board instance and allows you to pass several options to both the instance and module. The following options are available.

• route the base route for the bull-board instance adapter.
• adapter The routing adapter to be used, either the Express Adapter or Fastify Adapter provided by bull-board.
• boardOptions options as provided by the bull-board package, such as uiBasePath and uiConfig
• middleware optional middleware for the express adapter (e.g. basic authentication)

Register your queues

To register a new queue, you need to register BullBoardModule.forFeature in the same module as where your queues are registered.

1import { Module } from '@nestjs/common';
2import { BullBoardModule } from "nestjs-bull-board";
3import { BullModule } from "@nestjs/bullmq";
4
5@Module({
6  imports: [
7    BullModule.registerQueue(
8      {
9        name: 'my_awesome_queue'
10      }
11    ),
12    
13    BullBoardModule.forFeature({
14      name: 'my_awesome_queue',
15      adapter: BullMQAdapter, //or use BullAdapter if you're using bull instead of bullMQ
16    }),
17  ],
18})
19export class FeatureModule {}

The forFeature method registers the given queues to the bull-board instance. The following options are available.

• name the queue name to register
• adapter either BullAdapter or BullMQAdapter depending on which package you use.
• options queue adapter options as found in the bull-board package, such as readOnlyMode, description etc.

Using the bull-board instance in your controllers and/or services.

The created bull-board instance is available via the @InjectBullBoard() decorator. For example in a controller:

1import { Controller, Get } from "@nestjs/common";
2import { BullBoardInstance, InjectBullBoard } from "nestjs-bull-board";
3
4@Controller('my-feature')
5export class FeatureController {
6
7  constructor(
8    @InjectBullBoard() private readonly boardInstance: BullBoardInstance
9  ) {
10  }
11  
12  //controller methods
13}