:pencil: adding in some comments

frontend/src/services/chat.service.js

@@ -47,24 +47,37 @@ const testMessage = new ChatMessage({
 })
 const MAIN_CHANNEL = 'hello_world'
 
+/** Singleton that holds all our chat information */
 class Chatter {
+    /**
+     * Create our chatter instance
+     * @return {Chatter} our chatter instance object
+     */
     constructor() {
+        // Map of each active chat
         this.groupings = {}
+
+        // Our pubnub instance
         this.provider = null
+
+        // UUID used to identify unique users
         this.uuid = null
 
         // Setup the main channel
         this.subscriptions = [MAIN_CHANNEL]
-        
         this.listeners = {
             status: async e => {
                 if (e.category !== "PNConnectedCategory") return
-                await this._publish(this.subscriptions[0], testMessage)
+                await this.publish(this.subscriptions[0], testMessage)
             },
             message: this._onMessage,
             presence: this._onPresence
         }
     }
+    /**
+     * Callback that fires on every message
+     * @param {event} e
+     */
     async _onMessage(e) {
         console.log(e.message.title)
         console.log(e.message.description)
@@ -79,12 +92,29 @@ class Chatter {
         this._listenFor({ listeners: this.listeners })
         this._subscribe(this.subscriptions)
     }
-    async _publish(channel, message) {
+    /**
+     * Send a message to a channel
+     * example = new ChatMessage({ title: 'example', description: 'ni' })
+     * Facade so we can hide provider specific methods
+     * @param {string} channel
+     * @param {ChatMessage} message
+     * @return {object} timestamp
+     */
+    async publish(channel, message) {
         return await providerMethods['publish']({ channel, message })
     }
+    /** 
+     * Subscribe to a channels
+     * Facade so we can hide provider specific methods
+     * @param {array} channels
+    */
     _subscribe(channels) {
         providerMethods['subscribe']({ channels })
     }
+    /** 
+     * Listen to events and set callbacks
+     * Facade so we can hide provider specific methods
+    */
     _listenFor({ listeners }) {
         providerMethods['listen'](listeners)
     }

frontend/src/services/notification.service.js

@@ -1,5 +1,9 @@
 import { remote } from '../utils/db'
 
+/**
+ * Base notifier class
+ * @param {number} profileId needed to listen for events for this profile
+ */
 class Toaster {
     constructor(profileId) {
         this.url = `${remote}/notification/${profileId}/subscribe`
@@ -12,6 +16,9 @@ class Toaster {
     }
 }
 
+/**
+ * Example extension that listens for 'stonk' events
+ */
 class StonkAlert extends Toaster {
     constructor(profileId) {
         super(profileId)

frontend/src/views/home.vue

@@ -63,7 +63,6 @@ export default {
             const testAccountUUID = import.meta.env.VITE_TEST_ACCOUNT_UUID
             c.setup(testAccountUUID)
             console.log('---')
-            console.log(c)
         },
         processQueue(queueList) {
             const formattedList = []