Skip to content

Commit c5b7738

Browse files
efkandarrachequesne
authored andcommitted
[docs] Add server.engine.generateId attribute (socketio#2880)
1 parent 03f3bc9 commit c5b7738

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/API.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
- [new Server(port[, options])](#new-serverport-options)
77
- [new Server(options)](#new-serveroptions)
88
- [server.sockets](#serversockets)
9+
- [server.engine.generateId](#serverenginegenerateid)
910
- [server.serveClient([value])](#serverserveclientvalue)
1011
- [server.path([value])](#serverpathvalue)
1112
- [server.adapter([value])](#serveradaptervalue)
@@ -225,6 +226,18 @@ server.listen(PORT); // PORT is free to use
225226
io = Server(server);
226227
```
227228

229+
#### server.engine.generateId
230+
231+
Overwrites the default method to generate your custom socket id.
232+
233+
The function is called with a node request object (`http.IncomingMessage`) as first parameter.
234+
235+
```js
236+
io.engine.generateId = function (req) {
237+
return "custom:id:" + custom_id++; // custom id must be unique
238+
}
239+
```
240+
228241
### Namespace
229242

230243
Represents a pool of sockets connected under a given scope identified

0 commit comments

Comments
 (0)