34
34
35
35
``` js
36
36
const io = require (' socket.io' )(3000 );
37
- const redisAdapter = require (' socket.io- redis' );
37
+ const redisAdapter = require (' @ socket.io/ redis-adapter ' );
38
38
io .adapter (redisAdapter ({ host: ' localhost' , port: 6379 }));
39
39
```
40
40
41
41
### ES6 modules
42
42
43
43
``` js
44
44
import { Server } from ' socket.io' ;
45
- import redisAdapter from ' socket.io- redis' ;
45
+ import redisAdapter from ' @ socket.io/ redis-adapter ' ;
46
46
47
47
const io = new Server (3000 );
48
48
io .adapter (redisAdapter ({ host: ' localhost' , port: 6379 }));
@@ -53,7 +53,7 @@ io.adapter(redisAdapter({ host: 'localhost', port: 6379 }));
53
53
``` ts
54
54
// npm i -D @types/redis
55
55
import { Server } from ' socket.io' ;
56
- import { createAdapter } from ' socket.io- redis' ;
56
+ import { createAdapter } from ' @ socket.io/ redis-adapter ' ;
57
57
import { RedisClient } from ' redis' ;
58
58
59
59
const io = new Server (8080 );
@@ -63,7 +63,7 @@ const subClient = pubClient.duplicate();
63
63
io .adapter (createAdapter ({ pubClient , subClient }));
64
64
```
65
65
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
67
67
multiple Socket.IO instances in different processes or servers that can
68
68
all broadcast and emit events to and from each other.
69
69
@@ -248,7 +248,7 @@ Access the `pubClient` and `subClient` properties of the
248
248
Redis Adapter instance to subscribe to its ` error ` event:
249
249
250
250
``` js
251
- const adapter = require (' socket.io- redis' )(' localhost:6379' );
251
+ const adapter = require (' @ socket.io/ redis-adapter ' )(' localhost:6379' );
252
252
adapter .pubClient .on (' error' , function (){});
253
253
adapter .subClient .on (' error' , function (){});
254
254
```
@@ -258,7 +258,7 @@ also be forwarded to the adapter instance:
258
258
259
259
``` js
260
260
const io = require (' socket.io' )(3000 );
261
- const redisAdapter = require (' socket.io- redis' );
261
+ const redisAdapter = require (' @ socket.io/ redis-adapter ' );
262
262
io .adapter (redisAdapter ({ host: ' localhost' , port: 6379 }));
263
263
io .of (' /' ).adapter .on (' error' , function (){});
264
264
```
@@ -271,7 +271,7 @@ a connection string.
271
271
272
272
``` js
273
273
const redis = require (' redis' );
274
- const redisAdapter = require (' socket.io- redis' );
274
+ const redisAdapter = require (' @ socket.io/ redis-adapter ' );
275
275
const pubClient = redis .createClient (port, host, { auth_pass: " pwd" });
276
276
const subClient = pubClient .duplicate ();
277
277
io .adapter (redisAdapter ({ pubClient, subClient }));
@@ -283,7 +283,7 @@ io.adapter(redisAdapter({ pubClient, subClient }));
283
283
284
284
``` js
285
285
const io = require (' socket.io' )(3000 );
286
- const redisAdapter = require (' socket.io- redis' );
286
+ const redisAdapter = require (' @ socket.io/ redis-adapter ' );
287
287
const Redis = require (' ioredis' );
288
288
289
289
const startupNodes = [
@@ -307,7 +307,7 @@ io.adapter(redisAdapter({
307
307
308
308
``` js
309
309
const io = require (' socket.io' )(3000 );
310
- const redisAdapter = require (' socket.io- redis' );
310
+ const redisAdapter = require (' @ socket.io/ redis-adapter ' );
311
311
const Redis = require (' ioredis' );
312
312
313
313
const options = {
@@ -326,7 +326,7 @@ io.adapter(redisAdapter({
326
326
327
327
## Protocol
328
328
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:
330
330
```
331
331
prefix + '#' + namespace + '#'
332
332
```
@@ -343,7 +343,7 @@ prefix + '#' + namespace + '#' + room + '#'
343
343
344
344
A number of other libraries adopt this protocol including:
345
345
346
- - [ socket.io-emitter] ( https://github.com/socketio/socket.io-emitter )
346
+ - [ socket.io-redis- emitter] ( https://github.com/socketio/socket.io-redis -emitter )
347
347
- [ socket.io-python-emitter] ( https://github.com/GameXG/socket.io-python-emitter )
348
348
- [ socket.io-emitter-go] ( https://github.com/stackcats/socket.io-emitter-go )
349
349
0 commit comments