Mutations
useIsUsernameAvailable
Check username availability.
Requires the Better Auth username plugin. Import your configured authClient. It already carries the username methods from createAuthClient.
This check is modeled as a mutation because callers usually trigger it from user input, not from route-level data loading. Returned data is typed as { available: boolean; message: string | null }.
Usage
import { useIsUsernameAvailable } from "@better-auth-ui/solid/plugins/username"
const mutation = useIsUsernameAvailable(authClient)
mutation.mutate(/* params */)Options factory
import { isUsernameAvailableOptions } from "@better-auth-ui/core/plugins/username"
import { useMutation } from "@tanstack/solid-query"
const checkUsername = useMutation(() => isUsernameAvailableOptions(authClient))
checkUsername.mutate({ username: "alice" })Params
Prop
Type
Last updated on