@Sugoi\socket

!Sugoi logo


Introduction

SugoiJS is a minimal modular framework.

SugoiJS gives you the ability to use only what you need and do it fast.

this is a standalone module that can be functional on its own (as all of the SugoiJS modules).

The SugoiJS socket module uses the socket.io.

Installation

> npm install --save @sugoi/socket

$3

Bootstrapping done by:

import {SocketHandler} from "@sugoi/socket";

// serverInstance is express\koa instance
// in case you are using @socket\server, the instance returns from the 'listen' method
SocketHandler.init(serverInstance);

#### Socket Options

Init socket server with:

> namespace - assign different endpoint to the socket server, more info on socket.io documentation

> socketOptions - the socket server configurations

SocketHandler.init(serverInstance, socketConfig: SocketIOStatic.ServerOptions, namespace: string): SocketIOStatic.Server

> The socketOptions variable interface is the same as on socket.io documentation

socketOptions:{
path: string,
serveClient: boolean,
adapter:Adapter,
origins:string,
parser:Parser
}

$3

SugoiJS socket module provides you the @SocketOn(event:string, namespace:string) decorator.

This decorator registers the callback for an event.

Example:

// SocketOn(event: string, namespace: string = "/", ...middlewares:Array) {
@SocketOn('message',"/",(socket,data)=>{
console.log("log message data: %s from socket id: %s",data,socket.id);
})
function(data,socket){
socket.to(data.room).emit('message',data.message)
}

You can use as many decorators as you want.

$3

For getting the socketIO server instance, use the getServer() method of the SocketHandler instance method.

const io:SocketIOStatic.Server = SocketHandler.getHandler().getServer();

Documentation

You can find further information on Sugoi official website