Bull-Board
GitHub

    BullMQAdapter

    For the BullMQ queue library.

    Import

    import { BullMQAdapter } from '@bull-board/api/bullMQAdapter';
// or
const { BullMQAdapter } = require('@bull-board/api/bullMQAdapter');

    Usage

    import { createBullBoard } from '@bull-board/api';
import { BullMQAdapter } from '@bull-board/api/bullMQAdapter';
import { ExpressAdapter } from '@bull-board/express';
import { Queue } from 'bullmq';

const myQueue = new Queue('my-queue', {
  connection: { host: 'localhost', port: 6379 },
});

const serverAdapter = new ExpressAdapter();
serverAdapter.setBasePath('/admin/queues');

createBullBoard({
  queues: [new BullMQAdapter(myQueue)],
  serverAdapter,
});

    Options

    All options are optional.

    OptionTypeDefaultDescription
    readOnlyModebooleanfalseHides all queue and job actions.
    allowRetriesbooleantrueShows or hides the retry buttons. Ignored when readOnlyMode is true.
    descriptionstring''Queue description text displayed in the UI.
    displayNamestring''Overrides the queue name shown in the UI.
    prefixstring''Prepended to job names in the UI.
    delimiterstring''Delimiter between the prefix and the job name.

    Instance methods

    adapter.setFormatter('name', (job) => `#${job.name}`);
adapter.setFormatter('data', (data) => redact(data));
adapter.setFormatter('returnValue', (value) => redact(value));
adapter.setFormatter('progress', (progress) => `${Math.round(progress)}%`);

adapter.setVisibilityGuard((request) => {
  // return true to show this queue, false to hide it
  return request.headers['x-tenant-id'] === 'acme';
});

    Flow tree

    The flow tree tab on the job detail page works with BullMQAdapter queues. Enable it by passing a flow producer to createBullBoard:

    import { FlowProducer } from 'bullmq';
import { createBullBoard } from '@bull-board/api';

createBullBoard({
  queues: [new BullMQAdapter(myQueue)],
  serverAdapter,
  options: {
    uiConfig: { /* ... */ },
  },
  flowProducer: new FlowProducer({ connection: { host: 'localhost', port: 6379 } }),
});