datasquirel/package-shared/types/package-shared-index.js

39 lines
1.1 KiB
JavaScript
Raw Normal View History

2024-10-14 08:17:16 +00:00
// @ts-check
/**
* @typedef {object} PackageUserLoginRequestBody
* @property {string} encryptionKey
* @property {any} payload
* @property {string} database
* @property {string[]} [additionalFields]
* @property {boolean} [email_login]
* @property {string} [email_login_code]
* @property {string} [email_login_field]
* @property {boolean} [token]
* @property {boolean} [social]
2024-10-18 04:15:04 +00:00
* @property {DSQL_DatabaseSchemaType} [dbSchema]
2024-10-14 08:17:16 +00:00
*/
/**
* @typedef {object} PackageUserLoginLocalBody
* @property {any} payload
* @property {string[]} [additionalFields]
* @property {boolean} [email_login]
* @property {string} [email_login_code]
* @property {string} [email_login_field]
* @property {boolean} [token]
* @property {boolean} [social]
2024-10-18 04:15:04 +00:00
* @property {DSQL_DatabaseSchemaType} [dbSchema]
*/
/**
* @typedef {Object} GetReturn
* @property {boolean} success - Did the function run successfully?
* @property {*} [payload] - GET request results
* @property {string} [msg] - Message
* @property {string} [error] - Error Message
* @property {DSQL_TableSchemaType} [schema] - Error Message
2024-10-18 05:02:12 +00:00
*
* @exports GetReturn
2024-10-14 08:17:16 +00:00
*/