Socket
Socket
Sign inDemoInstall

socket.io-emitter

Package Overview
Dependencies
Maintainers
2
Versions
12
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

socket.io-emitter

[![Build Status](https://github.com/socketio/socket.io-emitter/workflows/CI/badge.svg)](https://github.com/socketio/socket.io-emitter/actions) [![NPM version](https://badge.fury.io/js/socket.io-emitter.svg)](http://badge.fury.io/js/socket.io-emitter)


Version published
Weekly downloads
12K
decreased by-11.24%
Maintainers
2
Weekly downloads
 
Created
Source

socket.io-emitter

Build Status NPM version

socket.io-emitter allows you to communicate with Socket.IO servers easily from another Node.js process (server side).

Emitter diagram

The emitter is also available in other programming languages:

It must be used in conjunction with socket.io-redis.

The current version is compatible with both:

  • socket.io-redis@5 (socket.io@2)
  • socket.io-redis@6 (socket.io@3)

Table of content

How to use

const io = require('socket.io-emitter')({ host: '127.0.0.1', port: 6379 });
setInterval(() => {
  io.emit('time', new Date);
}, 5000);
// Different constructor options.

//1. Initialize with host:port string
const 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([
    {
        host: "localhost",
        port: 6379
    },
    {
        host: "localhost",
        port: 6378
    },
]);
const io = require('socket.io-emitter')(Cluster);

Examples

const io = require('socket.io-emitter')({ host: '127.0.0.1', port: 6379 });

// sending to all clients
io.emit('broadcast', /* ... */);

// sending to all clients in 'game' room
io.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' namespace
nsp.emit('namespace', /* ... */);

// sending to all clients in 'admin' namespace and in 'notifications' room
nsp.to('notifications').emit('namespace', /* ... */);

Note: acknowledgements are not supported

Error handling

Access the redis to subscribe to its error event:

const emitter = require('socket.io-emitter')("localhost:6379");

emitter.redis.on('error', (err) => {
  console.log(err);
});

API

Emitter(client[, opts])

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.

License

MIT

FAQs

Package last updated on 29 Dec 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc