Information

• Version: 5.31.4
• Type: Issue/Story

Description

Looking the documentation, I can see that there is nothing saying that you have to declare the function $onConnection to make your service to work.

If you do not declare the $onConnection function, then when the server starts you will get:

TypeError: Cannot convert undefined or null to object
    at Function.keys (<anonymous>)
    at list.getWebsocketServices.reduce (C:\Users\Oktagon PC\Documents\raincrow\version-server\node_modules\@tsed\socketio\src\SocketIOModule.ts:67:16)
    at Array.reduce (<anonymous>)
    at SocketIOModule.printSocketEvents (C:\Users\Oktagon PC\Documents\raincrow\version-server\node_modules\@tsed\socketio\src\SocketIOModule.ts:63:46)
    at SocketIOModule.$afterListen (C:\Users\Oktagon PC\Documents\raincrow\version-server\node_modules\@tsed\socketio\src\SocketIOModule.ts:47:12)
    at Map.<anonymous> (C:\Users\Oktagon PC\Documents\raincrow\version-server\node_modules\@tsed\di\src\class\LocalsContainer.ts:15:34)
    at Generator.next (<anonymous>)
    at C:\Users\Oktagon PC\Documents\raincrow\version-server\node_modules\tslib\tslib.js:110:75
    at new Promise (<anonymous>)
    at Object.__awaiter (C:\Users\Oktagon PC\Documents\raincrow\version-server\node_modules\tslib\tslib.js:106:16)

And of course, your socket service won't work.

Example

import { SocketService, IO } from '@tsed/socketio'

@SocketService('/')
export class VersionSocket {
    constructor(
        @IO
        private io: SocketIO.Server
    ) {

    }

    aFunctionHere() {
        this.io.emit('something')
    }

    // $onConnection() {

    // }
}

Acceptance criteria

• Improve Socket.IO documentation