# `useSignOut`

Sign out users and reset the provider state.

## Usage

```tsx
import { useSignOut } from '@openfort/react';

function LogoutButton() {
  const { signOut, isLoading } = useSignOut();

  return (
    <button onClick={() => signOut()} disabled={isLoading}>
      Sign out
    </button>
  );
}
```

## Return type

```ts
type SignOutReturn = {
  signOut(options?: SignOutOptions): Promise<{}>
  isLoading: boolean
  isError: boolean
  isSuccess: boolean
  error: OpenfortError | null | undefined
}

type SignOutOptions = {
  onSuccess?: (data: {}) => void
  onError?: (error: OpenfortError) => void
  throwOnError?: boolean
}
```