Dynamic event handling

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 approach
Register events
registerSocketEvent method
This method allows us to register callback for an event - equivalent to socket.on(event,callback)
registerSocketEvent<T=any>(event: string, 
                           callback: (socket: SocketIOStatic.Socket, data: T) => void, 
                           middlewares?: Array<ISocketMiddleware> | string, 
                           namespace: string = "/")
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).
registerServerEvent<T=any>(event: string, 
                           callback: (socket: SocketIOStatic.Socket, data: T) => void, 
                           middlewares?: Array<ISocketMiddleware> | string, 
                           namespace: string = "/")
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)
deregisterSocketEvent(event: string);
event - The event name
deregisterServerEvent method
This method allows us to deregister callback for server event - equivalent to io.removeListener(event,callbackToRemove)
deregisterServerEvent(event: string);
event - The event name

@sugoi/socket - Previous

Handling server & namespace

Next - @sugoi/socket

Schema validator

Last modified 3yr ago

Copy link

Outline

registerSocketEvent method

registerServerEvent method

Deregister events

deregisterSocketEvent method

deregisterServerEvent method