Bootstrapping

Setting up the socket server

Initialize socket server

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

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

Example

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

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

Init parameters

serverInstance = Express\Koa server instance

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

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
 }

connectionCallback:(socket)=>void - Callback function for the socket server "connection" event.

disconnectCallback:(socket)=>void - Callback function for the socket server "disconnect" event.

Returned value

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