Skip to content

Commit 8c33b68

Browse files
authored
docs: fix broken links in the README (#460)
1 parent b4215cd commit 8c33b68

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,14 @@
1212
- [Compatibility table](#compatibility-table)
1313
- [How does it work under the hood?](#how-does-it-work-under-the-hood)
1414
- [API](#api)
15-
- [adapter(uri[, opts])](#adapteruri-opts)
16-
- [adapter(opts)](#adapteropts)
15+
- [adapter(pubClient, subClient[, opts])](#adapterpubclient-subclient-opts)
1716
- [RedisAdapter](#redisadapter)
18-
- [RedisAdapter#sockets(rooms: Set<String>)](#redisadaptersocketsrooms-setstring)
17+
- [RedisAdapter#sockets(rooms: Set&lt;String&gt;)](#redisadaptersocketsrooms-setstring)
1918
- [RedisAdapter#allRooms()](#redisadapterallrooms)
2019
- [RedisAdapter#remoteJoin(id:String, room:String)](#redisadapterremotejoinidstring-roomstring)
2120
- [RedisAdapter#remoteLeave(id:String, room:String)](#redisadapterremoteleaveidstring-roomstring)
2221
- [RedisAdapter#remoteDisconnect(id:String, close:Boolean)](#redisadapterremotedisconnectidstring-closeboolean)
23-
- [Client error handling](#client-error-handling)
24-
- [Custom client (eg: with authentication)](#custom-client-eg-with-authentication)
25-
- [With ioredis client](#with-ioredishttpsgithubcomluinioredis-client)
22+
- [With ioredis client](#with-ioredis-client)
2623
- [Cluster example](#cluster-example)
2724
- [Sentinel Example](#sentinel-example)
2825
- [Protocol](#protocol)
@@ -209,7 +206,7 @@ that a regular `Adapter` does not
209206
- `subClient`
210207
- `requestsTimeout`
211208

212-
### RedisAdapter#sockets(rooms: Set<String>)
209+
### RedisAdapter#sockets(rooms: Set&lt;String&gt;)
213210

214211
Returns the list of socket IDs connected to `rooms` across all nodes. See [Namespace#allSockets()](https://socket.io/docs/v3/server-api/#namespace-allSockets)
215212

0 commit comments

Comments
 (0)