datasquirel/users/logout-user.d.ts
Benjamin Toby d98deb06c5 Updates
2024-12-13 14:08:41 +01:00

32 lines
1.1 KiB
TypeScript

export = logoutUser;
/**
* Logout user
* ==============================================================================
* @param {object} params - Single Param object containing params
* @param {string} [params.encryptedUserString] - Encrypted User String
* @param {http.IncomingMessage & Object<string, any>} [params.request] - Request Object
* @param {http.ServerResponse & Object<string, any>} [params.response] - Http response object
* @param {string} [params.cookieString]
* @param {string} [params.database] - Target database name(slug): optional
* @param {string | number} [params.dsqlUserId]
*
* @returns {{success: boolean, msg: string, cookieNames?: any}}
*/
declare function logoutUser({ response, database, dsqlUserId, encryptedUserString, request, cookieString, }: {
encryptedUserString?: string;
request?: http.IncomingMessage & {
[x: string]: any;
};
response?: http.ServerResponse & {
[x: string]: any;
};
cookieString?: string;
database?: string;
dsqlUserId?: string | number;
}): {
success: boolean;
msg: string;
cookieNames?: any;
};
import http = require("http");