AaronPo/the-biergarten-app
1
0
Fork 0
mirror of https://github.com/aaronpo97/the-biergarten-app.git synced 2026-02-16 20:13:49 +00:00
Code Issues Packages Projects 1 Releases Wiki Activity

docs: update documentation for custom auth hooks

Browse Source
This commit is contained in:
Aaron William Po
2023-12-03 03:35:46 -05:00
parent 0353f82c20
commit 080eb4c3c3
3 changed files with 11 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/hooks/auth/useRedirectIfLoggedIn.ts
View File

@@ -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);