Skip to content

share/sharedb-redis-pubsub

Repository files navigation

sharedb-redis-pubsub

NPM Version Build Status Coverage Status

Redis pub/sub adapter adapter for ShareDB.

This ShareDB add-on gives you horizontal scalability; the ability to have a cluster of multiple server nodes rather than just a single server. Using this adapter, clients can connect to any machine in your cluster, and the ops they submit will be forwarded clients connected through other nodes, and there will be no race conditions with regard to persistence.

Usage

This snippet shows how to load this library and pass it into a new ShareDB instance.

// Redis client is an existing redis client connection
var redisPubsub = require('sharedb-redis-pubsub')({client: redisClient});

var backend = new ShareDB({
  db: db,  // db would be your mongo db or other storage location
  pubsub: redisPubsub
});