bull-master

library1.0.5jsnpmunverified

Bull Master is a UI dashboard for monitoring and managing Bull queues in Node.js applications. Version 1.0.5 provides a web interface to inspect jobs, retry failures, and clean completed/failed jobs. It integrates with Express or Koa as middleware. Different from alternatives like bull-board (which also supports BullMQ), Bull Master is specific to Bull and offers a simple setup. It relies on Bull and Redis being installed separately. The library does not process jobs itself; it only visualizes queue state. Updated occasionally, with limited features compared to more active projects.

devops

npm install bull-master

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · BULL-MASTER

bull-master

devopsjavascriptv1.0.5

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

bullMaster

✓ const bullMaster = require('bull-master')

✗ import bullMaster from 'bull-master'

This package does not ship TypeScript definitions; use require() for CommonJS.

bullMasterApp

✓ const bullMasterApp = bullMaster({ queues: [someQueue] })

✗ const bullMasterApp = new bullMaster({ queues: [...] })

bullMaster is a function, not a class. Do not use 'new'.

bullMaster.koa

✓ router.all('/admin/queues*', bullMaster.koa({ queues: [someQueue], prefix: '/admin/queues' }))

✗ app.use(bullMaster.koa({ queues: [someQueue] }))

For Koa, you must specify a prefix option and use router.all, not app.use directly.

Sets up an Express server with Bull Master to monitor two Bull queues at /admin/queues.

const express = require('express'); const Queue = require('bull'); const bullMaster = require('bull-master'); const app = express(); const videoQueue = new Queue('video processing', 'redis://127.0.0.1:6379'); const imageQueue = new Queue('image processing', 'redis://127.0.0.1:6379'); const bullMasterApp = bullMaster({ queues: [videoQueue, imageQueue], }); app.use('/admin/queues', bullMasterApp); app.listen(3000, () => { console.log('Bull Master UI available at http://localhost:3000/admin/queues'); });

Debug

Known issues

gotchabullMaster() must be called with an array of Bull Queue instances, not queue names.

fix

Pass an array of created Bull Queue objects: bullMaster({ queues: [queueInstance] })

affects: >=1.0.0

gotchaFor Koa, you must set the 'prefix' option to match the route path, otherwise the UI will not load correctly.

fix

Add prefix: '/admin/queues' option when using bullMaster.koa() and use router.all with the wildcard route.

affects: >=1.0.0

deprecatedNo breaking changes reported for this version. However, the package has low activity and may not work with newer Bull versions.

fix

Test compatibility with your Bull version; consider using bull-board for ongoing support.

affects: >=1.0.0

Errors

Common errors & fixes

Cannot find module 'bull'

Bull is not installed as a peer dependency.

fix

Install bull: npm install bull

bullMaster is not a function

Using import statement instead of require; the package does not support ESM.

fix

Use const bullMaster = require('bull-master')

TypeError: Cannot read property 'getQueues' of undefined

Creating bull master app with new bullMaster() instead of calling bullMaster() as a function.

fix

Remove 'new': const bullMasterApp = bullMaster({ queues: [...] })

Upgrade

Version history

1.0.5latest on npm

Audit

Dependencies

bullrequiredPeer dependency: Bull Master visualizes Bull queues, so Bull must be installed.

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/hans-lizihan/bull-master ↗

packagebull-master ↗

homepagehttps://github.com/hans-lizihan/bull-master ↗