useConvexAuth

useConvexAuth configures token fetching for the shared runtime and exposes the current auth state.

Import

const { isLoading, isAuthenticated } = useConvexAuth()

import { useConvexAuth } from 'vue-convex'

Signature

function useConvexAuth(options?: {
  fetchToken?: AuthTokenFetcher
}): {
  isLoading: ComputedRef<boolean>
  isAuthenticated: ComputedRef<boolean>
}

Behavior

• Call with fetchToken once near the root to configure auth
• Call without options in descendant components to read the shared state
• Resets auth state when the scope that configured fetchToken is disposed
• Re-applies auth when the client reconnects

Related renderless components

The root package also exports:

• ConvexAuthenticated
• ConvexUnauthenticated
• ConvexAuthLoading

These components are client-only and read from the same shared auth state.

Related pages

• Authentication
• useConvexQuery