// Different constructor options.//1. Initialize with host:port stringconst io = require('socket.io-emitter')("localhost:6379")// 2. Initlize with host, port object.const io = require('socket.io-emitter')({ host: '127.0.0.1', port: 6379 });// 3. Can use other node_redis compatible client eg; ioredis.const Redis = require("ioredis");const redis = new Redis();const io = require('socket.io-emitter')(redis);// Make the emitter works with redis clustered environment.const Cluster = new Redis.Cluster([
Examples
const io = require('socket.io-emitter')({ host: '127.0.0.1', port: 6379 });// sending to all clientsio.emit('broadcast', /* ... */);// sending to all clients in 'game' roomio.to('game').emit('new-game', /* ... */);// sending to individual socketid (private message)io.to(socketId).emit('private', /* ... */);const nsp = io.of('/admin');// sending to all clients in 'admin' namespacensp.emit('namespace'
client is a node_redis
compatible client that has been initialized with the return_buffers
option set to true. This argument is optional.
The following options are allowed:
key: the name of the key to pub/sub events on as prefix (socket.io)
host: host to connect to redis on (localhost)
port: port to connect to redis on (6379)
socket: unix domain socket to connect to redis on ("/tmp/redis.sock")
Emitter(clientUri[, opts])
Same as above, but clientUri is a string of the format host:port
to connect to redis to.
Emitter(opts)
If you don't want to supply a redis client object, and want
socket.io-emitter to intiialize one for you, make sure to supply the
host and port options.
Emitter#to(room:String):Emitter
Emitter#in(room:String):Emitter
Specifies a specific room that you want to emit to.
Emitter#of(namespace:String):Emitter
Specifies a specific namespace that you want to emit to.