datasquirel/users/reauth-user.d.ts

43 lines
2.1 KiB
TypeScript
Raw Normal View History

2024-11-08 15:44:31 +00:00
export = reauthUser;
/** ****************************************************************************** */
/** ****************************************************************************** */
/** ****************************************************************************** */
/** ****************************************************************************** */
/** ****************************************************************************** */
/** ****************************************************************************** */
/**
* ==============================================================================
* Main Function
* ==============================================================================
* @async
*
* @param {object} params - Single Param object containing params
* @param {String} params.key - API Key
* @param {String} params.database - Target Database
* @param {http.ServerResponse} params.response - Http response object
* @param {http.IncomingMessage} params.request - Http request object
* @param {("deep" | "normal")} [params.level] - Authentication level
* @param {String} params.encryptionKey - Encryption Key
* @param {String} params.encryptionSalt - Encryption Salt
* @param {string[]} [params.additionalFields] - Additional Fields to be added to the user object
* @param {string} [params.token] - access token to use instead of getting from cookie header
2024-12-06 10:44:26 +00:00
* @param {boolean} [params.user_id] - User ID
2024-12-06 11:55:03 +00:00
* @param {boolean} [params.useLocal]
2024-11-08 15:44:31 +00:00
*
* @returns { Promise<import("../package-shared/types").ReauthUserFunctionReturn> }
*/
2024-12-06 11:55:03 +00:00
declare function reauthUser({ key, database, response, request, level, encryptionKey, encryptionSalt, additionalFields, token, user_id, useLocal, }: {
2024-11-08 15:44:31 +00:00
key: string;
database: string;
response: http.ServerResponse;
request: http.IncomingMessage;
level?: ("deep" | "normal");
encryptionKey: string;
encryptionSalt: string;
additionalFields?: string[];
token?: string;
2024-12-06 10:44:26 +00:00
user_id?: boolean;
2024-12-06 11:55:03 +00:00
useLocal?: boolean;
2024-11-08 15:44:31 +00:00
}): Promise<import("../package-shared/types").ReauthUserFunctionReturn>;
import http = require("http");