datasquirel/package-shared/types/package-shared-index.js
2024-10-18 05:15:04 +01:00

37 lines
1.1 KiB
JavaScript

// @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]
* @property {DSQL_DatabaseSchemaType} [dbSchema]
*/
/**
* @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]
* @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
*/