`useSignOut`

Sign out users and reset the provider state.

Usage

import { useSignOut } from '@openfort/react';
 
function LogoutButton() {
  const { signOut, isLoading } = useSignOut();
 
  return (
    <button onClick={() => signOut()} disabled={isLoading}>
      Sign out
    </button>
  );
}

Return type

type SignOutReturn = {
  signOut(options?: SignOutOptions): Promise<{} | { error: OpenfortError }>
  isLoading: boolean
  isError: boolean
  isSuccess: boolean
  error?: OpenfortError | null
}
 
type SignOutOptions = {
  onSuccess?: () => void
  onError?: (error: OpenfortError) => void
  onSettled?: (data: {} | undefined, error: OpenfortError | null) => void
  throwOnError?: boolean
}