Javadoc for src/app complete

src/app/channel/chatHandler.js

@@ -25,7 +25,14 @@ const emoteValidator = require('../../validators/emoteValidator');
 const chat = require('./chat');
 const {userModel} = require('../../schemas/user/userSchema');
 
+/**
+ * Class containing global server-side chat relay logic
+ */
 module.exports = class{
+    /**
+     * Instantiates a chatHandler object
+     * @param {channelManager} server - Parent Server Object
+     */
     constructor(server){
         //Set server
         this.server = server;
@@ -35,6 +42,10 @@ module.exports = class{
         this.chatBufferSize = 50;
     }
 
+    /**
+     * Defines global server-side chat relay event listeners
+     * @param {Socket} socket - Requesting Socket
+     */
     defineListeners(socket){
         socket.on("chatMessage", (data) => {this.handleChat(socket, data)});
         socket.on("setFlair", (data) => {this.setFlair(socket, data)});
@@ -43,10 +54,20 @@ module.exports = class{
         socket.on("deletePersonalEmote", (data) => {this.deletePersonalEmote(socket, data)});
     }
 
+    /**
+     * Handles incoming chat messages from client connections
+     * @param {Socket} socket - Socket we're receiving the request from
+     * @param {Object} data - Event payload
+     */
     handleChat(socket, data){
         this.commandPreprocessor.preprocess(socket, data);
     }
 
+    /**
+     * Handles incoming client request to change flair 
+     * @param {Socket} socket - Socket we're receiving the request from
+     * @param {Object} data - Event payload
+     */
     async setFlair(socket, data){
         var userDB = await userModel.findOne({user: socket.user.user});
 
@@ -66,6 +87,11 @@ module.exports = class{
         }
     }
 
+    /**
+     * Handles incoming client request to change high level 
+     * @param {Socket} socket - Socket we're receiving the request from
+     * @param {Object} data - Event payload
+     */
     async setHighLevel(socket, data){
         var userDB = await userModel.findOne({user: socket.user.user});
 
@@ -89,6 +115,11 @@ module.exports = class{
         }
     }
 
+    /**
+     * Handles incoming client request to add a personal emote
+     * @param {Socket} socket - Socket we're receiving the request from
+     * @param {Object} data - Event payload
+     */
     async addPersonalEmote(socket, data){
         //Sanatize and Validate input
         const name = emoteValidator.manualName(data.name);
@@ -119,6 +150,11 @@ module.exports = class{
         }
     }
 
+    /**
+     * Handles incoming client request to delete a personal emote
+     * @param {Socket} socket - Socket we're receiving the request from
+     * @param {Object} data - Event payload
+     */
     async deletePersonalEmote(socket, data){
         //Get user doc from DB based on socket
         const userDB = await userModel.findOne({user: socket.user.user});
@@ -130,10 +166,25 @@ module.exports = class{
     }
 
     //Base chat functions
+    /**
+     * Creates a new chatObject and relays the resulting message to the given channel
+     * @param {String} user - Originating user
+     * @param {String} flair - Flair ID to mark chat with
+     * @param {Number} highLevel - High Level to mark chat with
+     * @param {String} msg - Message Text Content
+     * @param {String} type - Message Type, used for client-side chat post-processing.
+     * @param {String} chan - Channel to broadcast message within
+     * @param {Array} links - Array of URLs/Links to hand to the client-side chat post-processor to inject into the final message.
+     */
     relayChat(user, flair, highLevel, msg, type = 'chat', chan, links){
         this.relayChatObject(chan, new chat(user, flair, highLevel, msg, type, links));
     }
 
+    /**
+     * Relays an existing chat object to a channel
+     * @param {String} chan - Channel to broadcast message within
+     * @param {chat} chat - Chat Object representing the message to broadcast to the given channel
+     */
     relayChatObject(chan, chat){
         //Send out chat
         this.server.io.in(chan).emit("chatMessage", chat);
@@ -150,46 +201,107 @@ module.exports = class{
         channel.chatBuffer.push(chat);
     }
 
+    /**
+     * Creates a new chatObject and relays the resulting message to the given socket
+     * @param {Socket} socket - Socket we're sending a message to (sounds menacing, huh?)
+     * @param {String} user - Originating user
+     * @param {String} flair - Flair ID to mark chat with
+     * @param {Number} highLevel - High Level to mark chat with
+     * @param {String} msg - Message Text Content
+     * @param {String} type - Message Type, used for client-side chat post-processing.
+     * @param {String} chan - Channel to broadcast message within
+     * @param {Array} links - Array of URLs/Links to hand to the client-side chat post-processor to inject into the final message.
+     */
     relayPrivateChat(socket, user, flair, highLevel, msg, type, links){
         this.relayPrivateChatObject(socket , new chat(user, flair, highLevel, msg, type, links));
     }
 
+    /**
+     * Handles incoming client request to delete a personal emote
+     * @param {Socket} socket - Socket we're receiving the request from
+     * @param {Object} data - Event payload
+     */
     relayPrivateChatObject(socket, chat){
         socket.emit("chatMessage", chat);
     }
 
+    /**
+     * Creates a new chatObject and relays the resulting message to the entire server
+     * @param {String} user - Originating user
+     * @param {String} flair - Flair ID to mark chat with
+     * @param {Number} highLevel - High Level to mark chat with
+     * @param {String} msg - Message Text Content
+     * @param {String} type - Message Type, used for client-side chat post-processing.
+     * @param {Array} links - Array of URLs/Links to hand to the client-side chat post-processor to inject into the final message.
+     */
     relayGlobalChat(user, flair, highLevel, msg, type = 'chat', links){
         this.relayGlobalChatObject(new chat(user, flair, highLevel, msg, type, links));
     }
 
+    /**
+     * Relays an existing chat object to the entire server
+     * @param {chat} chat - Chat Object representing the message to broadcast throughout the server
+     */
     relayGlobalChatObject(chat){
         this.server.io.emit("chatMessage", chat);
     }
 
     //User Chat Functions
+    /**
+     * Relays a chat message from a user to the rest of the channel based on socket
+     * @param {Socket} socket - Socket we're receiving the request from
+     * @param {String} msg - Message Text Content
+     * @param {String} type - Message Type, used for client-side chat post-processing.
+     * @param {Array} links - Array of URLs/Links to hand to the client-side chat post-processor to inject into the final message.
+     */
     relayUserChat(socket, msg, type, links){
         const user = this.server.getSocketInfo(socket);
         this.relayChat(user.user, user.flair, user.highLevel, msg, type, socket.chan, links);
     }
 
     //Toke Chat Functions
+    /**
+     * Broadcasts toke callout to the server
+     * @param {String} msg - Message Text Content
+     * @param {Array} links - Array of URLs/Links to hand to the client-side chat post-processor to inject into the final message.
+     */
     relayTokeCallout(msg, links){
         this.relayGlobalChat("Tokebot", "", '∞', msg, "toke", links);
     }
-
+    /**
+     * Broadcasts toke callout to the server
+     * @param {Socket} socket - Socket we're sending the whisper to
+     * @param {String} msg - Message Text Content
+     * @param {Array} links - Array of URLs/Links to hand to the client-side chat post-processor to inject into the final message.
+     */
     relayTokeWhisper(socket, msg, links){
         this.relayPrivateChat(socket, "Tokebot", "", '∞', msg, "tokewhisper", links);
     }
 
+    /**
+     * Broadcasts toke whisper to the server
+     * @param {String} msg - Message Text Content
+     * @param {Array} links - Array of URLs/Links to hand to the client-side chat post-processor to inject into the final message.
+     */
     relayGlobalTokeWhisper(msg, links){
         this.relayGlobalChat("Tokebot", "", '∞', msg, "tokewhisper", links);
     }
 
     //Announcement Functions
+    /**
+     * Broadcasts announcement to the server
+     * @param {String} msg - Message Text Content
+     * @param {Array} links - Array of URLs/Links to hand to the client-side chat post-processor to inject into the final message.
+     */
     relayServerAnnouncement(msg, links){
         this.relayGlobalChat("Server", "", '∞', msg, "announcement", links);
     }
 
+    /**
+     * Broadcasts announcement to a given channel
+     * @param {String} msg - Message Text Content
+     * @param {Array} links - Array of URLs/Links to hand to the client-side chat post-processor to inject into the final message.
+     */
     relayChannelAnnouncement(chan, msg, links){
         const activeChan = this.server.activeChannels.get(chan);
 
@@ -200,6 +312,11 @@ module.exports = class{
     }
 
     //Misc Functions
+    /**
+     * Clears chat for a given channel, targets specified user or entire channel if none found/specified.
+     * @param {String} user - User chats to clear
+     * @param {String} chan - Channel to broadcast message within
+     */
     clearChat(chan, user){
         const activeChan = this.server.activeChannels.get(chan);