# useEnsSignOut

A React hook for handling ENS-based sign-out functionality and session cleanup.

***

## Usage

```typescript
import { useEnsSignOut } from '@justaname.id/react'

// Basic usage
function EnsSignOutComponent() {
  const { signOut, isSignOutPending } = useEnsSignOut()
  
  const handleSignOut = async () => {
    try {
      await signOut()
    } catch (err) {
      console.error('Sign out failed:', err)
    }
  }
  
  return (
    <div>
      <button onClick={handleSignOut} disabled={isSignOutPending}>
        {isSignOutPending ? 'Signing Out...' : 'Sign Out'}
      </button>
    </div>
  )
}
```

```typescript
// With custom backend configuration
function EnsSignOutComponent() {
  const { signOut, isSignOutPending } = useEnsSignOut({
    backendUrl: 'https://api.justaname.id',
    signoutRoute: '/auth/signout',
    currentEnsRoute: '/auth/current-ens',
    signinNonceRoute: '/auth/nonce',
    local: false
  })
  
  const handleSignOut = async () => {
    await signOut()
  }
  
  return (
    <button onClick={handleSignOut} disabled={isSignOutPending}>
      {isSignOutPending ? 'Signing Out...' : 'Sign Out'}
    </button>
  )
}
```

***

## Returns

[`UseEnsSignOutResult`](/sdk-reference/justaname-react-sdk/interfaces/useenssignoutresult.md) - An object containing:

* `signOut`: Function to initiate the sign-out process
* `isSignOutPending`: Boolean indicating if the sign-out is in progress

## Parameters

* **params?**: [`UseEnsSignOutParams`](/sdk-reference/justaname-react-sdk/interfaces/useenssignoutparams.md) - Optional parameters for the hook

## Defined in

[packages/@justaname.id/react/src/lib/hooks/signIn/useEnsSignOut.ts:19](https://github.com/JustaName-id/JustaName-sdk/blob/dc845c10af242e3ca87d95ef392516ac0bfa8b95/packages/@justaname.id/react/src/lib/hooks/signIn/useEnsSignOut.ts#L19)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.justaname.id/sdk-reference/justaname-react-sdk/functions/useenssignout.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.