updates

users/add-user.js

@@ -12,19 +12,25 @@ const https = require("https");
 /** ****************************************************************************** */
 /** ****************************************************************************** */
 
+/**
+ * @typedef {Promise<object>} FunctionReturn
+ * @property {boolean} success - Did the function run successfully?
+ * @property {(Object[]|string)} [payload=[]] - Payload
+ */
+
 /**
  * ==============================================================================
  * Main Function
  * ==============================================================================
- * @param {String} key - API Key
- * @param {String} database - Target Database
- * @param {String | Object} payload - User Object. Eg. {
-        first_name: "Benjamin",
-        last_name:"Toby",
-        email:"benoti.san@gmail.com",
-        username:"tben",
-        password:"12345678",
-    }
+ * @async
+ *
+ * @param {{
+ *  key: string,
+ *  payload: string,
+ *  database: string
+ * }}
+ *
+ * @returns {FunctionReturn}
  */
 module.exports = async function ({ key, payload, database }) {
     /**

users/login-user.js

@@ -13,24 +13,25 @@ const encrypt = require("../functions/encrypt");
 /** ****************************************************************************** */
 /** ****************************************************************************** */
 
+/**
+ * @typedef {Promise<object>} FunctionReturn
+ * @property {boolean} success - Did the function run successfully?
+ * @property {(Object[]|string)} [payload=[]] - Payload
+ */
+
 /**
  * ==============================================================================
  * Main Function
  * ==============================================================================
- * @param {String} key - API Key
- * @param {String} database - Target Database
- * @param {Object} payload - SQL query String or Request Object. Eg. {
-        action: "insert | update | delete",
-        data: {
-            user_id: user.id,
-            user_first_name: user.first_name,
-            user_last_name: user.last_name,
-        },
-        table: "posts",
-    }
- * @param {Object} response - Http response object
- * @param {String} encryptionKey - Encryption Key
- * @param {String} encryptionSalt - Encryption Salt
+ * @param {object} params - Single Param object containing params
+ * @param {String} params.key - API Key
+ * @param {String} params.database - Target Database
+ * @param {(Object | string)} [params.payload={ action: "insert | update | delete", data: {}, table: "posts"  }] SQL query String or Request
+ * @param {Object} params.response - Http response object
+ * @param {String} params.encryptionKey - Encryption Key
+ * @param {String} params.encryptionSalt - Encryption Salt
+ *
+ * @returns {FunctionReturn}
  */
 module.exports = async function ({ key, payload, database, response, encryptionKey, encryptionSalt }) {
     /**

users/logout-user.js

@@ -2,7 +2,9 @@
  * ==============================================================================
  * Main Function
  * ==============================================================================
- * @param {Object} response - Http response object
+ * @param {object} params - Single Param object containing params
+ * @param {object} params.request - Http request object
+ * @param {object} params.response - Http response object
  */
 module.exports = function ({ request, response }) {
     /**

users/update-user.js

@@ -12,20 +12,25 @@ const https = require("https");
 /** ****************************************************************************** */
 /** ****************************************************************************** */
 
+/**
+ * @typedef {Promise<object>} FunctionReturn
+ * @property {boolean} success - Did the function run successfully?
+ * @property {(Object[]|string)} [payload=[]] - Payload
+ */
+
 /**
  * ==============================================================================
  * Main Function
  * ==============================================================================
- * @param {String} key - API Key
- * @param {String} database - Target Database
- * @param {String | Object} payload - User Object. Eg. {
-        id: 3, ****Required
-        first_name: "Benjamin",
-        last_name:"Toby",
-        email:"benoti.san@gmail.com",
-        username:"tben",
-        password:"12345678",
-    }
+ * @async
+ *
+ * @param {object} params - API Key
+ * @param {String} params.key - API Key
+ * @param {String} params.database - Target Database
+ * @param {String | Object} [params.payload={ id: 4, first_name: "Benjamin" }] - User Object.
+ * @param {number} [params.payload.id] - User id => Required
+ *
+ * @returns {FunctionReturn}
  */
 module.exports = async function ({ key, payload, database }) {
     /**