[Enhancement] Changed the deploy command export statement, added more…

… docs for the custom modules
naseif · Oct 1, 2021 · 4042978 · 4042978
1 parent 012f236
commit 4042978
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 13 deletions.
diff --git a/deploy-commands.js b/deploy-commands.js
@@ -17,7 +17,7 @@ for (const folder of commandFolders) {
   }
 }
 
-async function registerSlashCommands(clientId, guildId) {
+module.exports.registerSlashCommands = async (clientId, guildId) => {
   try {
     await rest.put(Routes.applicationGuildCommands(clientId, guildId), {
       body: commands,
@@ -27,6 +27,4 @@ async function registerSlashCommands(clientId, guildId) {
   } catch (error) {
     console.error(error);
   }
-}
-
-module.exports = { registerSlashCommands };
+};
diff --git a/modules/commandsReadMe.js b/modules/commandsReadMe.js
@@ -2,8 +2,9 @@ const mdtable = require("mdtable");
 const { writeFileSync } = require("fs");
 
 /**
- *
+ * Creats a MD Table for github
  * @param {array} commands
+ * @returns New File containng the commands table
  */
 
 module.exports.commandsReadMe = (commands) => {

diff --git a/modules/embedSimple.js b/modules/embedSimple.js
@@ -1,8 +1,8 @@
 /**
- *
+ * Simple function for embed messages
  * @param {string} color
  * @param {string} description
- * @returns
+ * @returns Object Containing the new Embed
  */
 
 module.exports.embedMessage = (color, description) => {

diff --git a/modules/logger.js b/modules/logger.js
@@ -2,10 +2,10 @@ const moment = require("moment");
 const chalk = require("chalk");
 
 /**
- *
+ * Logger for debugging purposes
  * @param {string} message
  * @param {string} type
- * @returns
+ * @returns ""
  */
 
 module.exports.logger = (message, type = "log") => {

diff --git a/modules/mstoTime.js b/modules/mstoTime.js
@@ -1,7 +1,7 @@
 /**
- *
+ * Converts MS to HMS Format
  * @param {number} duration
- * @returns
+ * @returns Time in HMS Format
  */
 module.exports.msToTime = (duration) => {
   let milliseconds = parseInt((duration % 1000) / 100),

diff --git a/modules/requestAPI.js b/modules/requestAPI.js
@@ -1,9 +1,9 @@
 const fetch = require("node-fetch");
 
 /**
- *
+ * Performs a simple GET request
  * @param {string} url
- * @returns
+ * @returns Response from the API as JSON
  */
 
 module.exports.requestAPI = async (url) => {