datasquirel/users/logout-user.d.ts

26 lines
908 B
TypeScript
Raw Normal View History

2024-11-08 15:44:31 +00:00
export = logoutUser;
/**
* Logout user
* ==============================================================================
* @param {object} params - Single Param object containing params
2024-12-08 08:58:57 +00:00
* @param {string} params.encryptedUserString - Encrypted User String
* @param {http.ServerResponse & Object<string, any>} [params.response] - Http response object
* @param {string} [params.database] - Target database name(slug): optional
* @param {string | number} [params.dsqlUserId]
2024-11-08 15:44:31 +00:00
*
2024-12-08 08:58:57 +00:00
* @returns {{success: boolean, payload: string, cookieNames?: any}}
2024-11-08 15:44:31 +00:00
*/
2024-12-08 08:58:57 +00:00
declare function logoutUser({ response, database, dsqlUserId, encryptedUserString }: {
encryptedUserString: string;
response?: http.ServerResponse & {
[x: string]: any;
};
2024-11-08 15:44:31 +00:00
database?: string;
2024-12-08 08:58:57 +00:00
dsqlUserId?: string | number;
2024-11-08 15:44:31 +00:00
}): {
success: boolean;
payload: string;
2024-12-08 08:58:57 +00:00
cookieNames?: any;
2024-11-08 15:44:31 +00:00
};
import http = require("http");