vin-socket.server
v1.1.1
Published
This application maintains the light weight of transmision and performance over websocket connection
Downloads
7
Readme
VIN-SOCKET.SERVER
Is a websocket server side connection that minified the functionalities and strategies of ws for easy implementation of websocket.
This module required to install its peer module vin-socket.client to client side in order to work correctly.
Installation
npm install vin-socket.server
Features
- Easy to consume
- Modern approach
- Background digestion as binary
Usage Examples
Emit to client
const { createServer } = require("http");
const { SocketServer } = require("vin-socket.server");
const server = createServer().listen(3200);
const wsServer = new SocketServer({ path: "/", server });
wsServer.onConnect((client) => {
const client_id = client.getId();
client.emit("res:message", {
message: `Hello new client-${client_id}!`
})
});
Listen to client
...
wsServer.on("req:message", (payload, client) => {
const client_id = client.getId();
console.log(`Received payload from client-${client_id}`, payload)
});
Join to room
...
client.join('room1')
Emit to room
...
client.to('room1').emit({
message: "Hello to all inside of this room"
})
Contributing
Unfortunately we are not accepting any contributors yet this is under probitionary, but for your concerns and possible suggestions just email me at [email protected]
Changelog
We're using github release and based on semantic versioning