This commit is contained in:
Tben 2023-05-18 12:51:11 +01:00
parent 4e2b0373e0
commit dcd0576147
5 changed files with 11 additions and 10 deletions

View File

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

View File

@ -13,7 +13,7 @@ const https = require("https");
/** ****************************************************************************** */
/**
* @typedef {Promise<object>} FunctionReturn
* @typedef {object} FunctionReturn
* @property {boolean} success - Did the function run successfully?
* @property {(Object[]|string)} [payload=[]] - Payload
*/

View File

@ -14,7 +14,7 @@ const encrypt = require("../functions/encrypt");
/** ****************************************************************************** */
/**
* @typedef {Promise<object>} FunctionReturn
* @typedef {object} FunctionReturn
* @property {boolean} success - Did the function run successfully?
* @property {(Object[]|string)} [payload=[]] - Payload
*/

View File

@ -13,7 +13,7 @@ const https = require("https");
/** ****************************************************************************** */
/**
* @typedef {Promise<object>} FunctionReturn
* @typedef {object} FunctionReturn
* @property {boolean} success - Did the function run successfully?
* @property {(Object[]|string)} [payload=[]] - Payload
*/

View File

@ -27,12 +27,13 @@ const https = require("https");
* @param {Object} params - Single object passed
* @param {string} params.key - API Key
* @param {string} params.database - Database Name
* @param {(Object | string)} params.query - SQL query String or Request Object
* @param {string} [params.query.action="insert"] - Query action => insert | update | delete
* @param {string} params.query.table - Database table slug
* @param {string} params.query.identifierColumnName - Name of column(or field) to match
* @param {(string | number)} params.query.identifierValue - Value attached to target column(or field)
* @param {Object} params.query.data - data to be inserted: eg. { id: 1267, first_name: John, last_name: Doe }
* @param {({
* action: [string="insert"],
* table: string,
* identifierColumnName: string,
* identifierValue: (string|number),
* data: object,
* } | string)} params.query - SQL query String or Request Object
*
* @returns { PostReturn } - Return Object
*/