3434
3535``` js
3636const io = require (' socket.io' )(3000 );
37- const redisAdapter = require (' socket.io- redis' );
37+ const redisAdapter = require (' @ socket.io/ redis-adapter ' );
3838io .adapter (redisAdapter ({ host: ' localhost' , port: 6379 }));
3939```
4040
4141### ES6 modules
4242
4343``` js
4444import { Server } from ' socket.io' ;
45- import redisAdapter from ' socket.io- redis' ;
45+ import redisAdapter from ' @ socket.io/ redis-adapter ' ;
4646
4747const io = new Server (3000 );
4848io .adapter (redisAdapter ({ host: ' localhost' , port: 6379 }));
@@ -53,7 +53,7 @@ io.adapter(redisAdapter({ host: 'localhost', port: 6379 }));
5353``` ts
5454// npm i -D @types/redis
5555import { Server } from ' socket.io' ;
56- import { createAdapter } from ' socket.io- redis' ;
56+ import { createAdapter } from ' @ socket.io/ redis-adapter ' ;
5757import { RedisClient } from ' redis' ;
5858
5959const io = new Server (8080 );
@@ -63,7 +63,7 @@ const subClient = pubClient.duplicate();
6363io .adapter (createAdapter ({ pubClient , subClient }));
6464```
6565
66- By running Socket.IO with the ` socket.io- redis ` adapter you can run
66+ By running Socket.IO with the ` @ socket.io/ redis-adapter ` adapter you can run
6767multiple Socket.IO instances in different processes or servers that can
6868all broadcast and emit events to and from each other.
6969
@@ -248,7 +248,7 @@ Access the `pubClient` and `subClient` properties of the
248248Redis Adapter instance to subscribe to its ` error ` event:
249249
250250``` js
251- const adapter = require (' socket.io- redis' )(' localhost:6379' );
251+ const adapter = require (' @ socket.io/ redis-adapter ' )(' localhost:6379' );
252252adapter .pubClient .on (' error' , function (){});
253253adapter .subClient .on (' error' , function (){});
254254```
@@ -258,7 +258,7 @@ also be forwarded to the adapter instance:
258258
259259``` js
260260const io = require (' socket.io' )(3000 );
261- const redisAdapter = require (' socket.io- redis' );
261+ const redisAdapter = require (' @ socket.io/ redis-adapter ' );
262262io .adapter (redisAdapter ({ host: ' localhost' , port: 6379 }));
263263io .of (' /' ).adapter .on (' error' , function (){});
264264```
@@ -271,7 +271,7 @@ a connection string.
271271
272272``` js
273273const redis = require (' redis' );
274- const redisAdapter = require (' socket.io- redis' );
274+ const redisAdapter = require (' @ socket.io/ redis-adapter ' );
275275const pubClient = redis .createClient (port, host, { auth_pass: " pwd" });
276276const subClient = pubClient .duplicate ();
277277io .adapter (redisAdapter ({ pubClient, subClient }));
@@ -283,7 +283,7 @@ io.adapter(redisAdapter({ pubClient, subClient }));
283283
284284``` js
285285const io = require (' socket.io' )(3000 );
286- const redisAdapter = require (' socket.io- redis' );
286+ const redisAdapter = require (' @ socket.io/ redis-adapter ' );
287287const Redis = require (' ioredis' );
288288
289289const startupNodes = [
@@ -307,7 +307,7 @@ io.adapter(redisAdapter({
307307
308308``` js
309309const io = require (' socket.io' )(3000 );
310- const redisAdapter = require (' socket.io- redis' );
310+ const redisAdapter = require (' @ socket.io/ redis-adapter ' );
311311const Redis = require (' ioredis' );
312312
313313const options = {
@@ -326,7 +326,7 @@ io.adapter(redisAdapter({
326326
327327## Protocol
328328
329- The ` socket.io- redis ` adapter broadcasts and receives messages on particularly named Redis channels. For global broadcasts the channel name is:
329+ The ` @ socket.io/ redis-adapter ` adapter broadcasts and receives messages on particularly named Redis channels. For global broadcasts the channel name is:
330330```
331331prefix + '#' + namespace + '#'
332332```
@@ -343,7 +343,7 @@ prefix + '#' + namespace + '#' + room + '#'
343343
344344A number of other libraries adopt this protocol including:
345345
346- - [ socket.io-emitter] ( https://github.com/socketio/socket.io-emitter )
346+ - [ socket.io-redis- emitter] ( https://github.com/socketio/socket.io-redis -emitter )
347347- [ socket.io-python-emitter] ( https://github.com/GameXG/socket.io-python-emitter )
348348- [ socket.io-emitter-go] ( https://github.com/stackcats/socket.io-emitter-go )
349349
0 commit comments