UNPKG

fenextjs-hook

Version:
31 lines (30 loc) 1.16 kB
import { UserProps } from "fenextjs-interface/cjs/User"; /** * Properties to configure the useUser hook. */ export interface useUserProps<U = UserProps> { /** * Name Var of save user in localStorage. */ varName?: string; onValidateUser?: (user: U | null | undefined) => boolean; urlRedirectInLogin?: string; urlRedirectInLogout?: string; onLogOut?: () => void; onLogin?: () => void; } /** * Hook to manage user data and authentication. * @param validateTokenUser Function to validate the user's token. By default, it will check that the user * object has a "token" property and decode it using JSON web tokens. * You can replace it with your own custom validation function. * @returns An object with the user data and authentication methods. */ export declare const useUser: <U = UserProps>({ varName, onValidateUser, urlRedirectInLogin, urlRedirectInLogout, onLogOut: onLogOutProps, onLogin: onLoginProps, }: useUserProps<U>) => { load: boolean; user: U | null | undefined; setUser: (newValue: any) => void; onLogin: (data: U) => unknown; onLogOut: () => void; isValidUser: boolean; };