Add function comments for gRPC

Author: DerekQuoc

chronos_npm_package/chronos.js

@@ -101,13 +101,15 @@ chronos.track = () => {
   }
   return null;
 };
-/** ServerWrapper
+/**
+ * Wraps the gRPC server object to automatically write logs to user configed DB
+ *
  * If the provided database is MongoDB, connection will be made to the Mongodb Atlas
+ *
  * If the provided database is PostgreSQL, connection will be made to PostgreSQL client
- * Passes userConfig
- * @param {*} server 
- * @param {*} proto 
- * @param {*} methods 
+ * @param {*} server
+ * @param {*} proto
+ * @param {*} methods
  */
 chronos.ServerWrapper = (server, proto, methods) => {
   const { database } = userConfig;
@@ -119,7 +121,16 @@ chronos.ServerWrapper = (server, proto, methods) => {
   }
   return null;
 };
-
+/**
+ * Wraps the gRPC client to automatically write logs to user configed DB
+ *
+ * If the provided database is MongoDB, connection will be made to the Mongodb Atlas
+ *
+ * If the provided database is PostgreSQL, connection will be made to PostgreSQL client
+ *
+ * @param {*} client
+ * @param {*} service
+ */
 chronos.ClientWrapper = (client, service) => {
   const { database } = userConfig;
   if (database.type === 'MongoDB') {
@@ -131,6 +142,12 @@ chronos.ClientWrapper = (client, service) => {
   return null;
 };
 
+/**
+ * Allows the passthrough of metadata from gRPC server to gRPC client
+ *
+ * @param {*} client
+ * @param {*} servere
+ */
 chronos.link = (client, server) => {
   client.metadata = server.metadataHolder;
 };

chronos_npm_package/controllers/helpers.js

@@ -5,7 +5,7 @@ const helpers = {
    * Sets the default interval to 5 seconds and dockerized to false
    */
   validateInput(config) {
-    let { microservice, database, interval, dockerized, connection } = config;
+    const { microservice, database, interval, dockerized, connection } = config;
 
     // Validate all required fields exist and are valid input types
     if (!microservice || typeof microservice !== 'string') {
@@ -20,7 +20,9 @@ const helpers = {
       throw new Error('Invalid input "database URI": Please provide the URI to your database');
     }
     if (!database.connection || typeof database.connection !== 'string') {
-      throw new Error('Invalid input "database connection type: Please provide the type of connection');
+      throw new Error(
+        'Invalid input "database connection type: Please provide the type of connection'
+      );
     }
 
     // Validate database type
@@ -32,7 +34,7 @@ const helpers = {
     if (database.connection !== 'REST' && database.connection !== 'gRPC') {
       throw new Error(
         `Invalid database connection "${database.connection}". Chronos only supports REST and gRPC.`
-      )
+      );
     }
 
     // Default interval to one minute
@@ -55,7 +57,7 @@ const helpers = {
 
       // Setup notifications for user
       notifications.forEach(obj => {
-        const type = obj.type;
+        const { type } = obj;
 
         // Throw errors on unsupported notification methods
         if (!features.includes(type)) {