npmpackage.info

Gathering detailed insights and metrics for @bull-board/nestjs

Other packages similar to @bull-board/nestjs

nestjs-bull-board

1.2.1

NestJS module for bull-board

bull-board-nestjs-module

0.0.2

A NestJS module for Bull-Board dashboard.

@marcell19/bull-board-nestjs

6.3.2

A NestJS module for Bull-Board dashboard.

@bull-board-hiruy/nestjs

3.1.0

A NestJS module for Bull-Board dashboard.

Gathering detailed insights and metrics for @bull-board/nestjs

@bull-board/nestjs - 6.10.1 | npmpackage.info

@bull-board/nestjs

🎯 Queue background jobs inspector

6.10.1

2,796

MIT

TypeScript

1.73 kB

4.6

Installations

npm install @bull-board/nestjs

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

20.16.0

NPM Version

10.8.1 Score

95.9

Supply Chain

96.6

Quality

93.1

Maintenance

100

Vulnerability

99.6

License

Pull Requests

Open

4

Total

507

Closed

87

Merged

416

Issues

Open

25

Total

455

Closed

430

Releases

225

Release 6.10.1

v6.10.1

Updated on Jun 10, 2025

Release 6.10.0

v6.10.0

Updated on Jun 08, 2025

Release 6.9.6

v6.9.6

Updated on May 07, 2025

Release 6.9.5

v6.9.5

Updated on May 03, 2025

Release 6.9.4

v6.9.4

Updated on May 03, 2025

Release 6.9.3

v6.9.3

Updated on May 03, 2025

View All 225 releases

Languages

TypeScript

CSS

JavaScript

EJS

Dockerfile

TypeScript (83.84%)

CSS (14.95%)

JavaScript (0.89%)

EJS (0.27%)

Dockerfile (0.06%)

Developer

felixmosh

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

2,796 Stars

1,123 Commits

417 Forks

13 Watchers

46 Branches

98 Contributors

Updated on Jun 27, 2025

Bundle Size

6.14 kB

Minified

1.73 kB

Minified + Gzipped

Bundlephobia

Maintainers

View All 98 Contributors

Package Meta Information

Latest Version

6.10.1

Package Id

@bull-board/nestjs@6.10.1

Unpacked Size

30.84 kB

Size

6.66 kB

File Count

NPM Version

10.8.1

Node Version

20.16.0

Published on

Jun 10, 2025

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

@bull-board/api @nestjs/bull-shared @nestjs/common @nestjs/core reflect-metadata rxjs

Dev Dependencies

@bull-board/api @bull-board/express @bull-board/fastify @nestjs/bull-shared @nestjs/bullmq @nestjs/common @nestjs/core @types/node bull bullmq reflect-metadata rxjs typescript

@bull-board/nestjs

NestJS for bull-board.

Overview

Installation

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

1$ npm install --save @bull-board/nestjs @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 "@bull-board/nestjs";
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)

Express Authentication

For Express, install express-basic-auth:

1$ npm install --save express-basic-auth

Modify the BullBoardModule.forRoot() method:

1import basicAuth from "express-basic-auth";
2
3BullBoardModule.forRoot({
4  route: "/queues",
5  adapter: ExpressAdapter,
6  middleware: basicAuth({
7    challenge: true,
8    users: { admin: "passwordhere" },
9  }),
10}),

Fastify Authentication

For Fastify, you can use fastify-basic-auth:

1$ npm install --save fastify-basic-auth

Then apply it using middleware:

1import fastifyBasicAuth from "fastify-basic-auth";
2
3BullBoardModule.forRoot({
4  route: "/queues",
5  adapter: FastifyAdapter,
6  middleware: (req, res, next) => {
7    fastifyBasicAuth({
8      validate: async (username, password, req, reply) => {
9        if (username === "admin" && password === "passwordhere") {
10          return;
11        }
12        throw new Error("Unauthorized");
13      },
14    })(req, res, next);
15  },
16}),

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 "@bull-board/nestjs";
3import { BullMQAdapter } from "@bull-board/api/bullMQAdapter";
4import { BullModule } from "@nestjs/bullmq";
5
6@Module({
7  imports: [
8    BullModule.registerQueue(
9      {
10        name: 'my_awesome_queue'
11      }
12    ),
13    
14    BullBoardModule.forFeature({
15      name: 'my_awesome_queue',
16      adapter: BullMQAdapter, //or use BullAdapter if you're using bull instead of bullMQ
17    }),
18  ],
19})
20export 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 "@bull-board/nestjs";
3
4@Controller('my-feature')
5export class FeatureController {
6
7  constructor(
8    @InjectBullBoard() private readonly boardInstance: BullBoardInstance
9  ) {
10  }
11  
12  //controller methods
13}

Usage examples

Simple NestJS setup

For more info visit the main README

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Maintained

Determines if the project is "actively maintained".

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

9

SAST

Determines if the project uses static code analysis.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4.6

/10

Last Scanned on 2025-06-23

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More