useLogout

Provides a hook to log out a user, disconnecting the signer and triggering the disconnectAsync function.

Import

1
import { useLogout } from "@account-kit/react";

Usage

import { 
function useLogout(mutationArgs?: UseLogoutMutationArgs): UseLogoutResult
Provides a hook to log out a user, disconnecting the signer and triggering the disconnectAsync function.
useLogout } from "@account-kit/react";

const { 
const logout: UseMutateFunction<void, Error, void, unknown>
logout, 
const isLoggingOut: boolean
isLoggingOut, 
const error: Error | null
error } = 
function useLogout(mutationArgs?: UseLogoutMutationArgs): UseLogoutResult
Provides a hook to log out a user, disconnecting the signer and triggering the disconnectAsync function.
useLogout({
  // these are optional
  
onSuccess?: ((data: void, variables: void, context: unknown) => Promise<unknown> | unknown) | undefined
onSuccess: () => {
    // do something on success
  },
  
onError?: ((error: Error, variables: void, context: unknown) => Promise<unknown> | unknown) | undefined
onError: (
error: Error
error) => 
var console: Console
The console module provides a simple debugging console that is similar to the JavaScript console mechanism provided by web browsers.
The module exports two specific components:

A Console class with methods such as console.log(), console.error() and console.warn() that can be used to write to any Node.js stream. * A global console instance configured to write to process.stdout and process.stderr. The global console can be used without importing the node:console module.

Warning: The global console object's methods are neither consistently synchronous like the browser APIs they resemble, nor are they consistently asynchronous like all other Node.js streams. See the note on process I/O for more information.
Example using the global console:

const name = 'Will Robinson'; console.warn(`Danger $name! Danger!`); // Prints: Danger Will Robinson! Danger!, to stderr ```

Example using the `Console` class:

```js const out = getStreamSomehow(); const err = getStreamSomehow(); const myConsole = new console.Console(out, err);

myConsole.log('hello world'); // Prints: hello world, to out myConsole.log('hello %s', 'world'); // Prints: hello world, to out myConsole.error(new Error('Whoops, something bad happened')); // Prints: [Error: Whoops, something bad happened], to err

const name = 'Will Robinson'; myConsole.warn(`Danger $name! Danger!`); // Prints: Danger Will Robinson! Danger!, to err ```
console.
Console.error(message?: any, ...optionalParams: any[]): void (+1 overload)
Prints to stderr with newline. Multiple arguments can be passed, with the first used as the primary message and all additional used as substitution values similar to printf(3) (the arguments are all passed to util.format()).
js const code = 5; console.error('error #%d', code); // Prints: error #5, to stderr console.error('error', code); // Prints: error 5, to stderr 
If formatting elements (e.g. %d) are not found in the first string then util.inspect() is called on each argument and the resulting string values are concatenated. See util.format() for more information.
error(
error: Error
error),
});

Parameters

mutationArgs

UseLogoutMutationArgs optional arguments to customize the mutation behavior

Returns

UseLogoutResult an object containing the logout function, a boolean indicating if logout is in progress, and any error encountered during logout