# socket-room-system
> ``` js // initialize express and socket.io servers const express = require('express') const {Server} = require('socket.io') const { createServer } = require('http') const app = express() const httpServer = createServer(app) const io = new Server(h
Latest version **1.2.0** (published 2021-10-29) · 0 weekly downloads
## Install
```sh
npm install socket-room-system
pnpm add socket-room-system
yarn add socket-room-system
bun add socket-room-system
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.2.0 |
| Published | 2021-10-29 |
| First published | 2021-09-23 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 20.2 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | ted_romato |
## Links
- npm: https://www.npmjs.com/package/socket-room-system
- npm.io page: https://npm.io/package/socket-room-system
## Dependencies (1)
- [uuid](https://npm.io/package/uuid.md) ^8.3.2
## Recent versions
- 1.2.0 (latest) — 2021-10-29
- 1.1.9 — 2021-10-29
- 1.1.8 — 2021-10-29
- 1.1.7 — 2021-10-29
- 1.1.6 — 2021-10-29
- 1.1.5 — 2021-10-29
- 1.1.4 — 2021-10-26
- 1.1.3 — 2021-10-25
- 1.1.2 — 2021-10-24
- 1.1.1 — 2021-10-24
- 1.1.0 — 2021-10-24
- 1.0.9 — 2021-10-24
- 1.0.8 — 2021-10-17
- 1.0.7 — 2021-10-17
- 1.0.6 — 2021-10-17
- … 6 more at https://npm.io/package/socket-room-system/versions
## README
# socketRoomSystem
# example:
## main.js:
``` js
// initialize express and socket.io servers
const express = require('express')
const {Server} = require('socket.io')
const { createServer } = require('http')
const app = express()
const httpServer = createServer(app)
const io = new Server(httpServer)
// import socket-room-system module
const startRoomSystem = require('socket-room-system')
// import custom app constructor from game.js file (sample below)
const gameConstructor = require('./game.js')
// begin room system with arguments: custom app-contructor, io-server, express-app
startRoomSystem(gameConstructor, io, app)
//more express set-up
app.set('view engine', 'ejs')
app.use(express.static('public'))
app.get('/', (req, res) => {
res.render('index.ejs')
})
httpServer.listen(5000 || process.env.PORT, () => {
console.log('Server has started.')
})
```
## game.js:
``` js
// app has to implement recieveData and onConnect function
// app has a function broadcast, which is added in room system layer
// be sure not to overrride it
module.exports = () => {
return {
leader: undefined,
running: false,
counter:0,
interval:undefined,
// gets called when new client joins room
// client id is a uuid4 string
onConnect: function(clientId){
// if noone is connected make new client a leader
if(this.leader) return
this.leader = clientId
},
// gets called when room recieves data
// clientId is sender uuid
// in this example I differentiate between requests using data.type, but you can use any keyword (emit, message, command)
recieveData: function(clientId, data){
// on data.type 'startAutoAdd', if client issuing this command is a leader, and interval is not yet running
// start interval, that adds one to counter and broadcasts new value
if(data.type === 'startAutoAdd' && clientId === this.leader && !this.running){
this.running = true
this.interval = setInterval(() => {
this.counter += 1
// broadcasting message to everyone in room
this.broadcast({type: "counterChange", counter: this.counter})
}, 1000)
}
// leader can stop interval
if(data.type === 'stopAutoAdd' && clientId === this.leader && this.running){
this.running = false
clearInterval(this.interval)
}
// add one to counter and broadcast
if(data.type === "add"){
this.counter += 1
this.broadcast({type: "counterChange", counter: this.counter})
}
}
}
}
```
## index.js:
``` js
import { client } from "/socketRoomSystem-Client/client.js"
$("#CreateRoom").on('click', () => {
// client creates room, and joins it automatically
client.createRoom()
})
client.on("room_created",(roomId) => {
// createRoom callback -> roomId is uuid string of a new room
console.log("Created room with id: " + roomId)
})
$("#JoinRoom").on('click', () => {
// client joins a room -> argument is a uuid of existing room
client.joinRoom($("#JoinRoomId").val())
})
client.on("room_joined", (roomId) => {
// joinRoom callback
console.log("Joined room with id: " + roomId)
})
$("#GetRoomOptions").on('click', () => {
console.log("room opt")
// request room options
client.getRoomOptions()
})
client.on("room_options", (data)=>{
// getRoomOptions callback
// data -> roomObject
console.log(data)
})
client.on("room_state_changed", (data) => {
// is triggered when room changes it's configuration
// data contain option, that was changed and new val -> {option: "members", newVal: ["socketA","socketB","socketC"]}
// triggered for example when someone joins a room
console.log(data)
})
client.on('room_doesnt_exist', (room) => {
console.log(`room with id ${room} doesn't exist`)
})
$("#AutoAdd").on('click', () => {
// sendAppData passes data to your app on a server
client.sendAppData({type: 'startAutoAdd'})
})
$("#StopAutoAdd").on('click', () => {
client.sendAppData({type: 'stopAutoAdd'})
})
$("#Add").on('click', () => {
client.sendAppData({type: 'add'})
})
// gets called on a broadcast from your app
client.on("app_data", (data) => {
if(data.type === 'counterChange'){
$("#Counter").text(JSON.stringify(data.counter))
}
})
```
index.ejs:
```html
Document
Index
0
```
---
_Source: https://npm.io/package/socket-room-system · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._