V4.0
@sugoi/server
@Sugoi/ORM
@sugoi/socket
@sugoi/core
Dynamic event handling
Register and deregister events in run time.
As all of the Sugoi modules anything which can be achieve by decroators can also be achieved by simple methods.
The
SocketHandler class provides us the right method for achieving this approachRegister events
registerSocketEvent method
This method allows us to register callback for an event - equivalent to
socket.on(event,callback)1
registerSocketEvent<T=any>(event: string,
2
callback: (socket: SocketIOStatic.Socket, data: T) => void,
3
middlewares?: Array<ISocketMiddleware> | string,
4
namespace: string = "/")
Copied!
event - The event we want to bind the callback to.
callback - The callback method
middlewares - 0...n functions which should apply before the callback apply.
namespace - The namespace the event is related to (Default: "/")registerServerEvent method
Same as registerSocketEvent but related to server events - equivalent to
io.on(event,callback).1
registerServerEvent<T=any>(event: string,
2
callback: (socket: SocketIOStatic.Socket, data: T) => void,
3
middlewares?: Array<ISocketMiddleware> | string,
4
namespace: string = "/")
Copied!
event - The event we want to bind the callback to.
callback - The callback method
middlewares - Array of 0...n functions which should apply before the callback apply.
namespace - The namespace the event is related to (Default: "/")Deregister events
deregisterSocketEvent method
This method allows us to deregister callback for socket event - equivalent to
socket.removeListener(event,callbackToRemove)1
deregisterSocketEvent(event: string);
Copied!
event - The event namederegisterServerEvent method
This method allows us to deregister callback for server event - equivalent to
io.removeListener(event,callbackToRemove)1
deregisterServerEvent(event: string);
Copied!
event - The event name