useAuth
useAuth():
object
Combined auth hook with all auth state and methods
Returns
Section titled “Returns”object
| Name | Type | Default value |
|---|---|---|
isAuthenticated | boolean | !!session |
isLoading | boolean | - |
isSigningIn | boolean | signIn.isPending |
isSigningOut | boolean | signOut.isPending |
isSigningUp | boolean | signUp.isPending |
isUpdating | boolean | updateUser.isPending |
session | undefined | null | AuthSession | - |
signIn | UseMutateAsyncFunction<FluxbaseResponse<AuthResponseData | SignInWith2FAResponse>, Error, SignInCredentials, unknown> | signIn.mutateAsync |
signOut | UseMutateAsyncFunction<void, Error, void, unknown> | signOut.mutateAsync |
signUp | UseMutateAsyncFunction<FluxbaseAuthResponse, Error, SignUpCredentials, unknown> | signUp.mutateAsync |
updateUser | UseMutateAsyncFunction<UserResponse, Error, Partial<Pick<User, "email" | "metadata">>, unknown> | updateUser.mutateAsync |
user | undefined | null | User | - |