make optional param disable redirect

adds JSdoc comment syntax to give info about the param
complexdatacollective · May 3, 2024 · 0693003 · 0693003
1 parent 778a99c
commit 0693003
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 6 deletions.
diff --git a/actions/auth.ts b/actions/auth.ts
@@ -96,8 +96,11 @@ export async function login(formData: FormData) {
 
   return redirect('/dashboard');
 }
+/**
+ * @param disableRedirect If true, does not redirect to the homepage after logging out
+ */
 
-export async function logout(shouldRedirect?: boolean) {
+export async function logout(disableRedirect?: boolean) {
   const { session } = await getServerSession();
   if (!session) {
     return {
@@ -114,9 +117,9 @@ export async function logout(shouldRedirect?: boolean) {
     sessionCookie.attributes,
   );
 
-  if (shouldRedirect) {
-    return redirect('/');
+  if (disableRedirect) {
+    return;
   }
 
-  return;
+  return redirect('/');
 }
diff --git a/app/dashboard/_components/UserMenu.tsx b/app/dashboard/_components/UserMenu.tsx
@@ -3,7 +3,7 @@ import SubmitButton from '~/components/ui/SubmitButton';
 
 const UserMenu = () => {
   return (
-    <form action={() => logout(true)}>
+    <form action={() => logout()}>
       <SubmitButton variant="secondary" size="sm" type="submit">
         Sign out
       </SubmitButton>

diff --git a/components/Feedback/SignOutModal.tsx b/components/Feedback/SignOutModal.tsx
@@ -39,7 +39,7 @@ const SignOutModal = ({
           <AlertDialogCancel onClick={() => setOpenSignOutModal(false)}>
             Cancel
           </AlertDialogCancel>
-          <AlertDialogAction onClick={() => void logout()}>
+          <AlertDialogAction onClick={() => void logout(true)}>
             Sign Out and Hide Banner
           </AlertDialogAction>
         </AlertDialogFooter>