[feat] Allow to join several rooms at once (#2879)

This commit is contained in:
Damien Arrachequesne
2017-02-26 09:15:32 +01:00
committed by GitHub
parent 2d5b0026c5
commit 01a4623613
4 changed files with 40 additions and 8 deletions

View File

@@ -40,6 +40,7 @@
- [socket.emit(eventName[, ...args][, ack])](#socketemiteventname-args-ack)
- [socket.on(eventName, callback)](#socketoneventname-callback)
- [socket.join(room[, callback])](#socketjoinroom-callback)
- [socket.join(rooms[, callback])](#socketjoinrooms-callback)
- [socket.leave(room[, callback])](#socketleaveroom-callback)
- [socket.to(room)](#sockettoroom)
- [socket.in(room)](#socketinroom)
@@ -476,6 +477,14 @@ io.on('connection', function(client){
});
```
#### socket.join(rooms[, callback])
- `rooms` _(Array)_
- `callback` _(Function)_
- **Returns** `Socket` for chaining
Adds the client to the list of room, and fires optionally a callback with `err` signature (if any).
#### socket.leave(room[, callback])
- `room` _(String)_