Types

import type {
  AuthMeta,
  AuthMode,
  AuthRouteRules,
  AuthSession,
  AuthUser,
  RequireSessionOptions,
  UserMatch,
  SignOutOptions,
} from '@onmax/nuxt-better-auth'

AuthUser

The user object returned by useUserSession().

Additional fields depend on your Better Auth plugins.

AuthSession

The session object returned by useUserSession().

AuthMeta

Used in page meta and routeRules.auth.

definePageMeta({ auth: 'user' satisfies AuthMeta })
definePageMeta({ auth: { only: 'guest', redirectTo: '/' } satisfies AuthMeta })

AuthRouteRules

Extends Nitro route rules with:

• auth?: AuthMeta

export default defineNuxtConfig({
  routeRules: {
    '/dashboard': { auth: 'user' } satisfies AuthRouteRules,
  },
})

UserMatch<T>

Used for user matching in AuthMeta.user and RequireSessionOptions.user (OR logic for arrays, AND logic between fields).

RequireSessionOptions

The options object for requireUserSession(event, options?).

SignOutOptions

Used by signOut(options?) to run a post-sign-out callback:

await signOut({ onSuccess: () => navigateTo('/') })

Module augmentation

Augment AuthUser / AuthSession by declaring module #nuxt-better-auth.

Using Types

In Vue Components

<script setup lang="ts">
import type { AuthUser } from '#nuxt-better-auth'

const props = defineProps<{
  user: AuthUser
}>()
</script>

In Server Code

import type { AuthUser, AuthSession } from '#nuxt-better-auth'

export default defineEventHandler(async (event): Promise<AuthUser> => {
  const { user } = await requireUserSession(event)
  return user
})