datasquirel/dist/package-shared/actions/users/user-auth.d.ts
Benjamin Toby e82bcd0824 Updates
2025-01-25 14:20:25 +01:00

29 lines
955 B
TypeScript

import http from "http";
import { AuthenticatedUser } from "../../types";
type Param = {
request?: http.IncomingMessage & {
[s: string]: any;
};
req?: http.IncomingMessage & {
[s: string]: any;
};
cookieString?: string;
encryptedUserString?: string;
encryptionKey?: string;
encryptionSalt?: string;
level?: "deep" | "normal";
database?: string;
dsqlUserId?: string | number;
expiry?: number;
csrfHeaderName?: string;
debug?: boolean;
};
/**
* Authenticate User from request
* ==============================================================================
* @description This Function takes in a request object and returns a user object
* with the user's data
*/
export default function userAuth({ request, req, encryptionKey, encryptionSalt, level, database, dsqlUserId, encryptedUserString, expiry, cookieString, csrfHeaderName, debug, }: Param): AuthenticatedUser;
export {};