angelia.io 4.0.87 → 4.0.88

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "angelia.io",
-	"version": "4.0.87",
+	"version": "4.0.88",
 	"description": "WebSockets Server and Client API for node.js and the browser, with rooms support.",
 	"author": "@titoBouzout @boredofnames",
 	"license": "GPL",

package/readme.md

@@ -213,8 +213,7 @@ As in `socket.on('connect', () => console.log('connect happened!'))`
    flag `persistent`
 4. a socket will leave automatically all rooms on disconnection
 5. `socket.rooms` is a set with all the rooms the socket joined
-6. a room list is an iterable that returns all of the sockets in the
-   room
+6. `id` is assigned to the room on creation
 
 ```js
 import { Room, Rooms } from 'angelia.io/server'
@@ -245,14 +244,14 @@ const games = new Rooms(GameRoom)
 
 class Connection {
 	connect(socket) {
-		game.join(socket, 'room id here')
-		socket.room.id === 'room id here'
+		games.join(socket, 'room id here')
+		socket.game.id === 'room id here'
 		console.log(socket.rooms)
-		game.leave(socket, 'room id here')
+		games.leave(socket, 'room id here')
 
-		game.join(socket, 'a different room')
-		socket.room.id === 'a different room'
-		game.leave(socket, 'a different room')
+		games.join(socket, 'a different room')
+		socket.game.id === 'a different room'
+		games.leave(socket, 'a different room')
 	}
 }
 
@@ -262,6 +261,8 @@ Server.listen()
 
 ### `Room` Class
 
+Iterating `room` returns the sockets
+
 | signature                             | kind    | description                                      |
 | ------------------------------------- | ------- | ------------------------------------------------ |
 | `onCreate(socket)`                    | method  | dispatched when the room is created              |
@@ -277,6 +278,16 @@ Server.listen()
 | `broadcastOnce(socket, key, [value])` | method  | emits once to other sockets in the room          |
 | `id`                                  | any     | the room id                                      |
 
+### `Rooms` Class
+
+Iterating `rooms` returns the rooms
+
+| signature             | kind   | description                    |
+| --------------------- | ------ | ------------------------------ |
+| `get(id)`             | method | returns room with such an `id` |
+| `join(socket, [id])`  | method | adds socket to room `id`       |
+| `leave(socket, [id])` | method | removes socket from room `id`  |
+
 ## Authors
 
 - Tito Bouzout https://github.com/titoBouzout

package/server/Rooms.js

@@ -1,14 +1,18 @@
 import { join, leave } from './constants.js'
 
 export class Rooms {
-	constructor(Room) {
-		this.Room = Room
+	/** @param {Object} RoomClass */
+	constructor(RoomClass) {
+		this.RoomClass = RoomClass
 		this.rooms = new Map()
 	}
+	get(id) {
+		return this.rooms.get(id)
+	}
 	join(socket, id = undefined) {
 		let room = this.rooms.get(id)
 		if (!room) {
-			room = new this.Room()
+			room = new this.RoomClass()
 			room.id = room.id || id
 			this.rooms.set(id, room)