useSignOut¶

Import¶

import useSignOut from 'react-auth-kit/hooks/useSignOut';

Function Signature¶

useSignOut(): () => boolean

Sign Out React Hook

Call the hook to sign out and delete all the auth state

This will remove the authState from memory and also remove the stored data from cookie or localstorage

Returns¶

React Hook with SignOut Functionality

fn => (): boolean

Example¶

Here's a simple example:

import useSignOut from 'react-auth-kit/hooks/useSignOut'

const SecureComponent = () => {
  const signOut = useSignOut()
  return (
    <button onClick={() => signOut()}>Sign Out!</button>
  )
}

Remarks¶

For Now, this hook doesn't redirect automatically. So one needs to write the redirect logic himself.

const signOut = useSignOut()
signOut()
navigate('/login')

Throws¶

AuthError - Thrown if the Hook is used outside the Provider Scope.

Defined in¶

hooks/useSignOut.ts

— 🔑 —

React Auth Kit is MIT License code