improve type safety for useAuth hook with ensureSignedIn (#196)

workos · Jan 31, 2025 · 3a62b12 · 3a62b12
1 parent cdfcad2
commit 3a62b12
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/components/authkit-provider.tsx b/src/components/authkit-provider.tsx
@@ -166,6 +166,10 @@ export const AuthKitProvider = ({ children, onSessionExpired }: AuthKitProviderP
   );
 };
 
+export function useAuth(options: {
+  ensureSignedIn: true;
+}): AuthContextType & ({ loading: true; user: User | null } | { loading: false; user: User });
+export function useAuth(options?: { ensureSignedIn?: false }): AuthContextType;
 export function useAuth({ ensureSignedIn = false }: { ensureSignedIn?: boolean } = {}) {
   const context = useContext(AuthContext);