This commit is contained in:
Tben 2023-05-23 12:31:16 +01:00
parent 991a399ad2
commit b53c83c81c
2 changed files with 21 additions and 2 deletions

View File

@ -1,6 +1,6 @@
{ {
"name": "datasquirel", "name": "datasquirel",
"version": "1.1.23", "version": "1.1.24",
"description": "Cloud-based SQL data management tool", "description": "Cloud-based SQL data management tool",
"main": "index.js", "main": "index.js",
"scripts": { "scripts": {

View File

@ -16,13 +16,32 @@ const encrypt = require("../functions/encrypt");
/** /**
* @typedef {object} FunctionReturn * @typedef {object} FunctionReturn
* @property {boolean} success - Did the function run successfully? * @property {boolean} success - Did the function run successfully?
* @property {(Object[]|string)} [payload=[]] - Payload * @property {{
* id: number,
* first_name: string,
* last_name: string,
* username: string,
* email: string,
* phone: string,
* social_id: [string],
* image: string,
* image_thumbnail: string,
* verification_status: [number=0],
* social_login: [number],
* social_platform: [string],
* csrf_k: string,
* more_data: [string],
* logged_in_status: boolean,
* date: string,
* }} payload - Payload
*/ */
/** /**
* ============================================================================== * ==============================================================================
* Main Function * Main Function
* ============================================================================== * ==============================================================================
* @async
*
* @param {object} params - Single Param object containing params * @param {object} params - Single Param object containing params
* @param {String} params.key - API Key * @param {String} params.key - API Key
* @param {String} params.database - Target Database * @param {String} params.database - Target Database