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.
Arena
✓ import Arena from 'bull-arena'
✗ const Arena = require('bull-arena').default
Default export is a function. CommonJS require works: const Arena = require('bull-arena'). If using ESM, import Arena from 'bull-arena' works. Do not use .default.
Arena
✓ const Arena = require('bull-arena')
✗ const { Arena } = require('bull-arena')
Arena is default export, not named.
Arena (with Bull)
✓ const Bull = require('bull'); const Arena = require('bull-arena')({ Bull, queues: [...] })
✗ Arena({}); // missing Bull import
Must pass queue library instance to Arena options. For Bull, pass Bull property. For Bee, pass Bee property. For BullMQ, pass BullMQ property.
Mounts Arena as Express middleware for monitoring a Bull queue.
const Arena = require('bull-arena');
const Bull = require('bull');
const express = require('express');
const app = express();
const arena = Arena({
Bull,
queues: [
{
name: 'my-queue',
hostId: 'My Server',
type: 'bull',
redis: {
host: process.env.REDIS_HOST || 'localhost',
port: process.env.REDIS_PORT || 6379,
}
}
]
});
app.use('/', arena);
app.listen(3000, () => console.log('Arena running on port 3000'));
Errors
Common errors & fixes
TypeError: Arena is not a function
Using named import instead of default import in ESM.
fixUse `import Arena from 'bull-arena'` or `const Arena = require('bull-arena')`. Error: Missing 'name' property in queue definition
Queue object missing required 'name' key.
fixAdd 'name' to each queue object.
Error: Cannot find module 'bull'
Bull library not installed or not passed to Arena.
fixInstall bull and pass it as `Bul` property to Arena options.
Audit
Dependencies
expressrequiredWeb server framework
redisoptionalRedis client (used by Bee)
ioredisoptionalRedis client (used by Bull/BullMQ)
bee-queueoptionalOptional: Bee queue library if monitoring Bee
bulloptionalOptional: Bull queue library if monitoring Bull
bullmqoptionalOptional: BullMQ queue library if monitoring BullMQ