chore: adding js-docs

one-piece-team1 · Mar 16, 2021 · c2da695 · c2da695
1 parent 710e0ad
commit c2da695
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 1 deletion.
diff --git a/src/consumers/chat.consumer.ts b/src/consumers/chat.consumer.ts
@@ -23,6 +23,9 @@ export class ChatConsumerService {
     this.init();
   }
 
+  /**
+   * @description Init func
+   */
   init() {
     this.consumer
       .on('ready', () => {

diff --git a/src/sockets/chat.gateway.ts b/src/sockets/chat.gateway.ts
@@ -13,6 +13,9 @@ export class ChatSocketGateway {
     this.init();
   }
 
+  /**
+   * @description Init func
+   */
   public init() {
     this.wss = new WebSocket.Server({ port: config.WSPORT, path: '/chats' });
     this.wss.on('connection', (ws: WebSocket, req: Express.Request) => {

diff --git a/src/sockets/chat.service.ts b/src/sockets/chat.service.ts
@@ -9,6 +9,13 @@ export class ChatSocketService {
 
   constructor(private readonly chatSocketGateway: ChatSocketGateway) {}
 
+  /**
+   * @description Verify Identity
+   * @public
+   * @param {IChatRoom.ISocketWithIdentity} client
+   * @param {IChatRoom.IChatRoomEntity} chatRoom 
+   * @returns {boolean}
+   */
   protected isRightClient(
     client: IChatRoom.ISocketWithIdentity,
     chatRoom: IChatRoom.IChatRoomEntity,
@@ -22,10 +29,17 @@ export class ChatSocketService {
     return isClient;
   }
 
+  /**
+   * @description send new chat room
+   * @public
+   * @param {EChatRoom.EChatRoomSocketEvent} type
+   * @param {IChatRoom.IChatRoomEntity} chatRoomEvent
+   * @returns {void}
+   */
   public sendNewChatRoom(
     type: EChatRoom.EChatRoomSocketEvent,
     chatRoomEvent: IChatRoom.IChatRoomEntity,
-  ) {
+  ): void {
     this.chatSocketGateway.wss.clients.forEach(
       (client: IChatRoom.ISocketWithIdentity) => {
         const isClient = this.isRightClient(client, chatRoomEvent);