Bootstrapping

Last updated 2 months ago

Setting up a socket server

Initialize socket server

Setting up the socket server done by the socketService.init method:

By existing server

socketService.init(serverInstance:http.Server|express.Application,
namespace:string ="/",
socketConfig?:socketOptions,
connectionCallback?:(socket)=>void,
disconnectCallback?:(socket)=>void
):SocketIOStatic.Server;

By port

socketService.init(portNumber:number,
namespace:string ="/",
socketConfig?:socketOptions,
connectionCallback?:(socket)=>void,
disconnectCallback?:(socket)=>void
):SocketIOStatic.Server;

Example

import {SocketHandler} from "@sugoi/socket";
// serverInstance is server instance (sugoijs, express, koa, nodejs http etc.)
// in case you are using @socket\server, the instance returns from the 'listen' method
// signature - init(HttpServer: any, socketConfig: SocketIOStatic.ServerOptions, namespace: string): SocketIOStatic.Server
const SocketHandler = socketService.init(serverInstance);

Init parameters

serverInstance = The server instance the socket server should be attached to. socketConfig?:socketOptions - The socket server configurations with the same interface as on socket.io documentation

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

namespace:string- The socket server namespace to bind to, allow to assign different endpoint to the socket server, more info on socket.io documentation.

Returned value

The returned value of the SocketHandler.init method is the socket server instance (SocketIOStatic.Server).