From c2da6950b3e9b5b00c365df8b98a70a0bb0d20f5 Mon Sep 17 00:00:00 2001
From: lib <dreak603@gmail.com>
Date: Tue, 16 Mar 2021 17:26:56 +0800
Subject: [PATCH] chore: adding js-docs

---
 src/consumers/chat.consumer.ts |  3 +++
 src/sockets/chat.gateway.ts    |  3 +++
 src/sockets/chat.service.ts    | 16 +++++++++++++++-
 3 files changed, 21 insertions(+), 1 deletion(-)

diff --git a/src/consumers/chat.consumer.ts b/src/consumers/chat.consumer.ts
index 859484c..e0e0aba 100644
--- 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
index ab572f5..a452c22 100644
--- 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
index 1972c39..bd1bb8f 100644
--- 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);