diff --git a/src/hooks/auth/useConfirmUser.ts b/src/hooks/auth/useConfirmUser.ts index 5da709c..32c148a 100644 --- a/src/hooks/auth/useConfirmUser.ts +++ b/src/hooks/auth/useConfirmUser.ts @@ -5,6 +5,14 @@ import { useState, useContext, useEffect } from 'react'; import toast from 'react-hot-toast'; import useSWR from 'swr'; +/** + * A custom hook to confirm a user's account. + * + * @returns An object with the following properties: + * + * - `needsToLogin`: A boolean indicating whether the user needs to log in. + * - `tokenInvalid`: A boolean indicating whether the token is invalid. + */ const useConfirmUser = () => { const router = useRouter(); const { user, mutate } = useContext(UserContext); diff --git a/src/hooks/auth/useRedirectIfLoggedIn.ts b/src/hooks/auth/useRedirectIfLoggedIn.ts index 50e8ac0..56de0e3 100644 --- a/src/hooks/auth/useRedirectIfLoggedIn.ts +++ b/src/hooks/auth/useRedirectIfLoggedIn.ts @@ -3,14 +3,10 @@ import { useRouter } from 'next/router'; import { useContext } from 'react'; /** - * Custom React hook that redirects the user to the home page if they are logged in. + * A custom hook to redirect the user to the home page if they are logged in. * * This hook is used to prevent logged in users from accessing the login and signup pages - * by redirecting them to the home page. - * - * This hook should only be used in a component that is under the UserContext provider. - * - * @returns {void} + * and should only be used in a component that is under the UserContext provider. */ const useRedirectWhenLoggedIn = (): void => { const { user } = useContext(UserContext); diff --git a/src/hooks/auth/useUser.ts b/src/hooks/auth/useUser.ts index 39a98d7..3f5dd52 100644 --- a/src/hooks/auth/useUser.ts +++ b/src/hooks/auth/useUser.ts @@ -3,7 +3,7 @@ import APIResponseValidationSchema from '@/validation/APIResponseValidationSchem import useSWR from 'swr'; /** - * A custom React hook that fetches the current user's data from the server. + * A custom hook to fetch the current user's data. * * @returns An object with the following properties: *