npmpackage.info

Gathering detailed insights and metrics for socket.io-pm2

Other packages similar to socket.io-pm2

@socket.io/pm2

6.0.8

Production process manager for Node.JS applications with a built-in load balancer.

pm2-socket.io

1.0.2

PM2 Simple Socket.io Module

@grandeto/pm2-socket.io

5.1.2

Production process manager for Node.JS applications with a built-in load balancer.

lpcpanel

1.1.6

![Logo](http://utils.myportfolio.club/lpc-Panel.png)

Gathering detailed insights and metrics for socket.io-pm2

socket.io-pm2 - 1.0.0 | npmpackage.info

socket.io-pm2

Adapter to enable broadcasting of events to a cluster of socket.io nodes running under PM2.

1.0.0

MIT

JavaScript

26.49 kB

1.7

Installations

npm install socket.io-pm2

Developer Guide

BETA

Typescript

No

Module System

N/A

Node Version

11.7.0

NPM Version

6.4.0 Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

2

Total

3

Closed

1

Releases

Unable to fetch releases

Languages

JavaScript

Makefile

JavaScript (99.83%)

Makefile (0.17%)

Developer

dedo1911

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

2 Stars

173 Commits

1 Watchers

1 Branches

1 Contributors

Updated on Mar 17, 2023

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

1.0.0

Package Id

socket.io-pm2@1.0.0

Unpacked Size

26.49 kB

Size

5.93 kB

File Count

NPM Version

6.4.0

Node Version

11.7.0

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

debug notepack.io pm2 socket.io-adapter uid2

Dev Dependencies

expect.js mocha socket.io socket.io-client

socket.io-pm2

How to use

1const io = require('socket.io')(3000);
2const pm2Adapter = require('socket.io-pm2');
3io.adapter(pm2Adapter());

By running socket.io with the socket.io-pm2 adapter you can run multiple socket.io instances in different processes on the same pm2 cluster that can all broadcast and emit events to and from each other.

So any of the following commands:

1io.emit('hello', 'to all clients');
2io.to('room42').emit('hello', "to all clients in 'room42' room");
3
4io.on('connection', (socket) => {
5  socket.broadcast.emit('hello', 'to all clients except sender');
6  socket.to('room42').emit('hello', "to all clients in 'room42' room except sender");
7});

will properly be broadcast to the clients through PM2 IPC (inter-process communication).

If you need to emit events to socket.io instances from a non-socket.io process, you should use socket.io-emitter.

API

adapter([opts])

The following options are allowed:

key: the name of the key to pub/sub events on as prefix (socket.io)
requestsTimeout: optional, after this timeout the adapter will stop waiting from responses to request (5000ms)

PM2Adapter

The pm2 adapter instances expose the following properties that a regular Adapter does not

uid
prefix
requestsTimeout

PM2Adapter#clients(rooms:Array, fn:Function)

Returns the list of client IDs connected to rooms across all nodes. See Namespace#clients(fn:Function)

1io.of('/').adapter.clients((err, clients) => {
2  console.log(clients); // an array containing all connected socket ids
3});
4
5io.of('/').adapter.clients(['room1', 'room2'], (err, clients) => {
6  console.log(clients); // an array containing socket ids in 'room1' and/or 'room2'
7});
8
9// you can also use
10
11io.in('room3').clients((err, clients) => {
12  console.log(clients); // an array containing socket ids in 'room3'
13});

PM2Adapter#clientRooms(id:String, fn:Function)

Returns the list of rooms the client with the given ID has joined (even on another node).

1io.of('/').adapter.clientRooms('<my-id>', (err, rooms) => {
2  if (err) { /* unknown id */ }
3  console.log(rooms); // an array containing every room a given id has joined.
4});

PM2Adapter#allRooms(fn:Function)

Returns the list of all rooms.

1io.of('/').adapter.allRooms((err, rooms) => {
2  console.log(rooms); // an array containing all rooms (accross every node)
3});

PM2Adapter#remoteJoin(id:String, room:String, fn:Function)

Makes the socket with the given id join the room. The callback will be called once the socket has joined the room, or with an err argument if the socket was not found.

1io.of('/').adapter.remoteJoin('<my-id>', 'room1', (err) => {
2  if (err) { /* unknown id */ }
3  // success
4});

PM2Adapter#remoteLeave(id:String, room:String, fn:Function)

Makes the socket with the given id leave the room. The callback will be called once the socket has left the room, or with an err argument if the socket was not found.

1io.of('/').adapter.remoteLeave('<my-id>', 'room1', (err) => {
2  if (err) { /* unknown id */ }
3  // success
4});

PM2Adapter#remoteDisconnect(id:String, close:Boolean, fn:Function)

Makes the socket with the given id to get disconnected. If close is set to true, it also closes the underlying socket. The callback will be called once the socket was disconnected, or with an err argument if the socket was not found.

1io.of('/').adapter.remoteDisconnect('<my-id>', true, (err) => {
2  if (err) { /* unknown id */ }
3  // success
4});

PM2Adapter#customRequest(data:Object, fn:Function)

Sends a request to every nodes, that will respond through the customHook method.

1// on every node
2io.of('/').adapter.customHook = (data, cb) => {
3  cb('hello ' + data);
4}
5
6// then
7io.of('/').adapter.customRequest('john', function(err, replies){
8  console.log(replies); // an array ['hello john', ...] with one element per node
9});

Protocol

The socket.io-pm2 adapter broadcasts and receives messages on particularly named ipc topics.

For global broadcasts the channel name is:

prefix + '#' + namespace + '#'

In broadcasting to a single room the channel name is:

prefix + '#' + namespace + '#' + room + '#'

prefix: The base channel name. Default value is socket.io. Changed by setting opts.key in adapter(opts) constructor
namespace: See https://github.com/socketio/socket.io#namespace.
room : Used if targeting a specific room.

A number of other libraries adopt this protocol including:

License

MIT

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

68 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-42xw-2xvc-qx8m
Warn: Project is vulnerable to: GHSA-4w2v-q235-vp99
Warn: Project is vulnerable to: GHSA-cph5-m8f7-6c5x
Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx
Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-9j49-mfvp-vmhm
Warn: Project is vulnerable to: GHSA-j4f2-536g-r55m
Warn: Project is vulnerable to: GHSA-r7qp-cfhv-p84w
Warn: Project is vulnerable to: GHSA-2j2x-2gpw-g8fm
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-pc5p-h8pf-mvwp
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9
Warn: Project is vulnerable to: GHSA-8hfj-j24r-96c4
Warn: Project is vulnerable to: GHSA-wc69-rhjr-hc9g
Warn: Project is vulnerable to: GHSA-56x4-j7p9-fcf9
Warn: Project is vulnerable to: GHSA-v78c-4p63-2j6c
Warn: Project is vulnerable to: GHSA-4c7m-wxvm-r7gc
Warn: Project is vulnerable to: GHSA-pch5-whg9-qr2r
Warn: Project is vulnerable to: GHSA-6fx8-h7jm-663j
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-x5gf-qvw8-r2rm
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-fxwf-4rqh-v8g3
Warn: Project is vulnerable to: GHSA-25hc-qcg6-38wj
Warn: Project is vulnerable to: GHSA-xfhh-g9f5-x4m4
Warn: Project is vulnerable to: GHSA-qm95-pgcg-qqfq
Warn: Project is vulnerable to: GHSA-cqmj-92xf-r6r9
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-72mh-269x-7mh5
Warn: Project is vulnerable to: GHSA-h4j5-c7cj-74xg
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

1.7

/10

Last Scanned on 2025-07-14

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More