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.
MonitorServer
✓ import { MonitorServer } from 'redis-smq-monitor'
✗ const MonitorServer = require('redis-smq-monitor')
ESM import requires Node >= 14 and 'type': 'module' in package.json.
ConsumerEventListener
✓ import { ConsumerEventListener } from 'redis-smq-monitor'
Used in eventListeners config.
ProducerEventListener
✓ import { ProducerEventListener } from 'redis-smq-monitor'
Used in eventListeners config.
Initializes and starts the monitor server with Redis config, event listeners, and HTTP server settings.
import { MonitorServer } from 'redis-smq-monitor';
import { ConsumerEventListener, ProducerEventListener } from 'redis-smq-monitor';
const config = {
namespace: 'testing',
redis: {
client: 'redis',
options: {
host: process.env.REDIS_HOST ?? '127.0.0.1',
port: Number(process.env.REDIS_PORT ?? 6379),
},
},
eventListeners: {
consumerEventListeners: [ConsumerEventListener],
producerEventListeners: [ProducerEventListener],
},
server: {
host: '127.0.0.1',
port: 3000,
},
};
const monitorServer = new MonitorServer(config);
monitorServer.run().catch(err => console.error(err));
Debug
Known issues
breakingRedisSMQ Monitor requires redis-smq@7.2.3 as a peer dependency; incompatible with older or newer major versions.fixInstall redis-smq@7.2.3 exactly.
affects: >=7.0.0 <7.2.3 || >=8.0.0
breakingThe monitor is ESM-only since v3; CommonJS require() will fail.fixUse import statements and ensure 'type': 'module' in package.json.
affects: >=3.0.0
deprecatedConfiguration key 'server.basePath' is deprecated in favor of reverse proxy header handling.fixUse a reverse proxy (e.g., nginx) with X-Forwarded-Prefix header instead.
affects: >=7.0.0
gotchaMinimum Node.js version is 14; using older versions will cause runtime errors.fixUpgrade Node.js to >=14.
affects: <14.0.0
gotchaRedis server must be >= 2.6.12; older versions may cause protocol errors.affects: <2.6.12
Errors
Common errors & fixes
Cannot find module 'redis-smq-monitor'
Missing peer dependencies or incorrect package installation.
fixnpm install redis-smq-common redis-smq redis-smq-monitor --save
The requested module 'redis-smq-monitor' does not provide an export named 'MonitorServer'
Using CommonJS require() with an ESM-only package (v3+).
fixUse import { MonitorServer } from 'redis-smq-monitor' instead of require. Audit
Dependencies
redis-smqrequiredpeer dependency required for queue operations
redis-smq-commonrequiredpeer dependency providing Redis and logging utilities