chore(remix): Add comment

clerk · Dec 15, 2023 · 6325c0e · 6325c0e
1 parent 92cbd74
commit 6325c0e
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/packages/remix/src/ssr/getAuth.ts b/packages/remix/src/ssr/getAuth.ts
@@ -10,6 +10,8 @@ export async function getAuth(args: LoaderFunctionArgs, opts?: GetAuthOptions):
   if (!args || (args && (!args.request || !args.context))) {
     throw new Error(noLoaderArgsPassedInGetAuth);
   }
+
+  // Note: authenticateRequest() will throw a redirect if the auth state is determined to be handshake
   const requestState = await authenticateRequest(args, opts);
 
   return sanitizeAuthObject(requestState.toAuth());

diff --git a/packages/remix/src/ssr/rootAuthLoader.ts b/packages/remix/src/ssr/rootAuthLoader.ts
@@ -47,6 +47,7 @@ export const rootAuthLoader: RootAuthLoader = async (
     ? handlerOrOptions
     : {};
 
+  // Note: authenticateRequest() will throw a redirect if the auth state is determined to be handshake
   const requestState = await authenticateRequest(args, opts);
 
   if (!handler) {