Moduletrace/datasquirel
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updates

Browse Source
This commit is contained in:
Benjamin Toby
2024-12-08 09:58:57 +01:00
parent 8a8257d17e
commit 7bd4b2fe65
76 changed files with 1783 additions and 1106 deletions
Download Patch File Download Diff File Expand all files Collapse all files
users/login-user.d.ts
Vendored
+15 -11
View File
@@ -5,7 +5,7 @@ export = loginUser;
* @async
*
* @param {object} params - Single Param object containing params
* @param {String} params.key - FULL ACCESS API Key
* @param {String} [params.key] - FULL ACCESS API Key
* @param {String} params.database - Target Database
* @param {{
* email?: string,
@@ -13,9 +13,9 @@ export = loginUser;
* password: string,
* }} params.payload Login Email/Username and Password
* @param {string[]} [params.additionalFields] - Additional Fields to be added to the user object
* @param {http.ServerResponse} params.response - Http response object
* @param {String} params.encryptionKey - Encryption Key
* @param {String} params.encryptionSalt - Encryption Salt
* @param {http.ServerResponse & Object<string, any>} [params.response] - Http response object
* @param {String} [params.encryptionKey] - Encryption Key
* @param {String} [params.encryptionSalt] - Encryption Salt
* @param {boolean} [params.email_login] - Email only Login
* @param {string} [params.email_login_code] - Email login code
* @param {string} [params.temp_code_field] - Database table field name for temporary code
@@ -23,11 +23,12 @@ export = loginUser;
* @param {boolean} [params.user_id] - User ID
* @param {boolean} [params.skipPassword]
* @param {boolean} [params.useLocal]
* @param {string | number} [params.apiUserID] - Required for setting of cookies
*
* @returns { Promise<import("../package-shared/types").AuthenticatedUser>}
* @returns { Promise<import("../package-shared/types").APILoginFunctionReturn>}
*/
declare function loginUser({ key, payload, database, additionalFields, response, encryptionKey, encryptionSalt, email_login, email_login_code, temp_code_field, token, user_id, skipPassword, useLocal, }: {
key: string;
declare function loginUser({ key, payload, database, additionalFields, response, encryptionKey, encryptionSalt, email_login, email_login_code, temp_code_field, token, user_id, skipPassword, useLocal, apiUserID, }: {
key?: string;
database: string;
payload: {
email?: string;
@@ -35,9 +36,11 @@ declare function loginUser({ key, payload, database, additionalFields, response,
password: string;
};
additionalFields?: string[];
response: http.ServerResponse;
encryptionKey: string;
encryptionSalt: string;
response?: http.ServerResponse & {
[x: string]: any;
};
encryptionKey?: string;
encryptionSalt?: string;
email_login?: boolean;
email_login_code?: string;
temp_code_field?: string;
@@ -45,5 +48,6 @@ declare function loginUser({ key, payload, database, additionalFields, response,
user_id?: boolean;
skipPassword?: boolean;
useLocal?: boolean;
}): Promise<import("../package-shared/types").AuthenticatedUser>;
apiUserID?: string | number;
}): Promise<import("../package-shared/types").APILoginFunctionReturn>;
import http = require("http");