angelia.io 4.0.90 → 4.0.91

package/package.json

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

package/readme.md

@@ -205,13 +205,15 @@ As in `socket.on('connect', () => console.log('connect happened!'))`
 
 ## Rooms
 
+### Via a `Rooms` list
+
 1. Create a room class that extends `Room`
 2. Create a room list that will allow joining sockets
 3. Join a socket in a room, a socket may join multiple rooms. Rooms
    are created when the `id` of the room doesn't exists, and deleted
    when there are no sockets in the room and the room doesn't have the
    flag `persistent`
-4. a socket will leave automatically all rooms on disconnection
+4. A socket will leave automatically all rooms on disconnection
 5. `socket.rooms` is a set with all the rooms the socket joined
 6. `id` is assigned to the room on creation
 
@@ -219,7 +221,7 @@ As in `socket.on('connect', () => console.log('connect happened!'))`
 import { Room, Rooms } from 'angelia.io/server'
 
 class GameRoom extends Room {
-	persistent = true
+	persistent = false
 
 	onCreate(socket) {
 		console.log('creating room', this.id, socket)
@@ -240,6 +242,7 @@ class GameRoom extends Room {
 	}
 }
 
+// games is a room list
 const games = new Rooms(GameRoom)
 
 class Connection {
@@ -259,7 +262,62 @@ Server.on(Connection)
 Server.listen()
 ```
 
-### `Room` Class
+#### `Rooms` Class
+
+Iterating returns the rooms
+
+| signature                             | kind     | description                                   |
+| ------------------------------------- | -------- | --------------------------------------------- |
+| `get(id)`                             | method   | gets room with such an `id`                   |
+| `join(socket, [id])`                  | method   | adds socket to room `id`                      |
+| `leave(socket, [id])`                 | method   | removes socket from room `id`                 |
+| `connections`                         | number   | number of sockets in this room list           |
+| `sockets`                             | Iterator | sockets in this room list                     |
+| `emit(key, [value])`                  | method   | emits to all sockets in this room list        |
+| `once(key, [value])`                  | method   | emits once to all sockets in this room list   |
+| `broadcast(socket, key, [value])`     | method   | emits to other sockets in this room list      |
+| `broadcastOnce(socket, key, [value])` | method   | emits once to other sockets in this room list |
+| `map(fn)`                             | method   | returns mapped array                          |
+| `filter(fn)`                          | method   | returns mapped filtered array                 |
+
+### Via a `Room`
+
+1. Create a room instance that extends `Room`
+2. Join a socket in a room, a socket may join multiple rooms.
+3. A socket will leave automatically all rooms on disconnection
+4. `socket.rooms` is a set with all the rooms the socket joined
+5. Keep in mind that `onCreate` and `onDelete` are not dispatched when
+   the room is manged by yourself. The construtor could be used for
+   simulating `onCreate` and `onDelete` only you will know when to
+   dispose such a variable.
+
+```js
+import { Room } from 'angelia.io/server'
+
+class Lobby extends Room {
+	persistent = true
+	id = 'lobby'
+	onJoin(socket) {
+		console.log('socket joined room', this.id, socket)
+	}
+}
+
+// lobby is just 1 room
+const lobby = new Lobby()
+
+class Connection {
+	connect(socket) {
+		lobby.join(socket)
+
+		lobby.leave(socket)
+	}
+}
+
+Server.on(Connection)
+Server.listen()
+```
+
+#### `Room` Class
 
 Iterating returns the sockets
 
@@ -277,26 +335,10 @@ Iterating returns the sockets
 | `broadcast(socket, key, [value])`     | method  | emits to other sockets in the room               |
 | `broadcastOnce(socket, key, [value])` | method  | emits once to other sockets in the room          |
 | `id`                                  | any     | the room id                                      |
+| `join(socket)`                        | method  | adds a socket to the room                        |
+| `leave(socket)`                       | method  | remves a socket from the room                    |
 
-### `Rooms` Class
-
-Iterating returns the rooms
-
-| signature                             | kind     | description                                   |
-| ------------------------------------- | -------- | --------------------------------------------- |
-| `get(id)`                             | method   | gets room with such an `id`                   |
-| `join(socket, [id])`                  | method   | adds socket to room `id`                      |
-| `leave(socket, [id])`                 | method   | removes socket from room `id`                 |
-| `connections`                         | number   | number of sockets in this room list           |
-| `sockets`                             | Iterator | sockets in this room list                     |
-| `emit(key, [value])`                  | method   | emits to all sockets in this room list        |
-| `once(key, [value])`                  | method   | emits once to all sockets in this room list   |
-| `broadcast(socket, key, [value])`     | method   | emits to other sockets in this room list      |
-| `broadcastOnce(socket, key, [value])` | method   | emits once to other sockets in this room list |
-| `map(fn)`                             | method   | returns mapped array                          |
-| `filter(fn)`                          | method   | returns mapped filtered array                 |
-
-### `sockets` Object
+### `sockets` Object in `Room` and `Rooms`
 
 Like `Set` but with two aditional methods
 

package/server/Room.js

@@ -1,5 +1,3 @@
-import { join, leave } from './constants.js'
-
 import { Emitter } from './Emitter.js'
 
 export class Room extends Emitter {
@@ -16,7 +14,7 @@ export class Room extends Emitter {
 	onLeave(socket) {}
 
 	/** @param socket {import('./Socket.js').Socket} */
-	[join](socket) {
+	join(socket) {
 		this.sockets.add(socket)
 
 		socket.rooms.add(this)
@@ -24,7 +22,7 @@ export class Room extends Emitter {
 		this.onJoin(socket)
 	}
 	/** @param socket {import('./Socket.js').Socket} */
-	[leave](socket) {
+	leave(socket) {
 		this.sockets.delete(socket)
 
 		socket.rooms.delete(this)

package/server/Rooms.js

@@ -1,4 +1,4 @@
-import { join, leave, parent } from './constants.js'
+import { parent } from './constants.js'
 import { Emitter } from './Emitter.js'
 import { arrayFrom } from './utils.js'
 
@@ -30,13 +30,13 @@ export class Rooms extends Emitter {
 
 			room.onCreate(socket)
 		}
-		room[join](socket)
+		room.join(socket)
 	}
 
 	leave(socket, id = undefined) {
 		const room = this.rooms.get(id)
 		if (room) {
-			room[leave](socket)
+			room.leave(socket)
 			if (!room.persistent && room.sockets.size === 0) {
 				this.rooms.delete(id)
 				room.onDelete(socket)

package/server/Socket.js

@@ -97,7 +97,9 @@ export class Socket {
 		this.server.sockets.delete(this)
 
 		for (const room of this.rooms) {
-			room[parent].leave(this, room.id)
+			room[parent]
+				? room[parent].leave(this, room.id)
+				: room.leave(this)
 		}
 
 		this.server.events.disconnect &&

package/server/constants.js

@@ -1,3 +1 @@
-export const join = Symbol('join')
-export const leave = Symbol('leave')
 export const parent = Symbol('parent')