Skip to main content

logout

Function to disconnect from Web3Auth.

Usage​

function LogoutButton() {
  const handleLogout = async () => {
    try {
      await web3auth.logout();
      console.log("Logged out successfully");
    } catch (error) {
      console.error("Error logging out:", error);
    }
  };

  return <button onClick={handleLogout}>Logout</button>;
}

Function Signature​

logout(options?: { cleanup: boolean }): Promise<void>;

Parameters​

  • options (optional)
  • cleanup (boolean): Whether to remove all user data during logout.

Return Value​

Promise that resolves when the user is successfully logged out.