Registry / messaging / deepstream.io-msg-redis

deepstream.io-msg-redis

library1.0.5jsnpmunverified

Redis message connector for deepstream.io v1.x, enabling horizontal scaling via Redis pub/sub. Current version 1.0.5 (stable, last release 2017). Depends on ioredis. Only compatible with deepstream.io v1.x; not supported in v2+ due to API changes. Use deepstream.io v3+ built-in cluster or a custom connector for modern versions.

messaging

npm install deepstream.io-msg-redis

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · DEEPSTREAM.IO-MSG-

deepstream.io-msg-redis

messagingjavascriptv1.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.

RedisMessageConnector

✓ const RedisMessageConnector = require('deepstream.io-msg-redis')

✗ import RedisMessageConnector from 'deepstream.io-msg-redis'

The package is CJS-only; ESM import will fail.

RedisMessageConnector

✓ import RedisMessageConnector from 'deepstream.io-msg-redis'

If using deepstream v1 with Node <12, use CJS require.

RedisMessageConnector

✓ const RedisMessageConnector = require('deepstream.io-msg-redis')

✗ const { RedisMessageConnector } = require('deepstream.io-msg-redis')

The package exports a single constructor, not a named export.

Configures deepstream.io v1 to use Redis as message bus for horizontal scaling.

const Deepstream = require('deepstream.io'); const RedisMessageConnector = require('deepstream.io-msg-redis'); const server = new Deepstream(); server.set('messageConnector', new RedisMessageConnector({ host: process.env.REDIS_HOST || 'localhost', port: parseInt(process.env.REDIS_PORT || '6379', 10) })); server.start();

Debug

Known issues

breakingOnly compatible with deepstream.io v1.x. v2+ replaced the message connector API.

fix

Upgrade to deepstream.io v3+ and use built-in clustering or a custom connector.

affects: >=2.0.0

deprecatedPackage has not been updated since 2017. ioredis version may have breaking changes.

fix

Pin ioredis version in package.json (e.g., ioredis@^4.0.0) or migrate to a maintained connector.

affects: *

gotchaRequires a running Redis server. No built-in retry logic for connection failures.

fix

Ensure Redis is available before starting deepstream server.

affects: *

gotchaThe 'options' object passed to constructor also accepts 'nodes' array for cluster. Mixing 'host'/'port' with 'nodes' leads to undefined behavior.

fix

Use either single server config (host+port) or cluster config (nodes array).

affects: *

Errors

Common errors & fixes

Error: Cannot find module 'deepstream.io-msg-redis'

Package not installed or incorrect import path.

fix

Run: npm install deepstream.io-msg-redis. Then require with correct path.

TypeError: RedisMessageConnector is not a constructor

Using ES6 import instead of require, or destructuring the default export.

fix

Use: const RedisMessageConnector = require('deepstream.io-msg-redis');

Error: Redis connection refused

Redis server not running or wrong host/port.

fix

Start Redis or check REDIS_HOST/REDIS_PORT environment variables.

Upgrade

Version history

1.0.5latest on npm

Audit

Dependencies

ioredisrequiredpeer dependency for Redis communication

deepstream.iorequiredpeer dependency for deepstream server

Agent activity

24 hits · last 30 days

node

Amazon

OpenAI (training)

Resources

githubhttps://github.com/deepstreamIO/deepstream.io-msg-redis ↗

packagedeepstream.io-msg-redis ↗

homepagehttp://deepstream.io ↗