Hook to get the auth status of the user connection with the Towns network.

​
Imports

import { useTownsAuthStatus } from '@towns-protocol/react-sdk'

​
Definition

function useTownsAuthStatus(
  config?: ObservableConfig.FromObservable<AuthStatus>,
): {
    status: AuthStatus;
    isInitializing: boolean;
    isEvaluatingCredentials: boolean;
    isCredentialed: boolean;
    isConnectingToTowns: boolean;
    isConnectedToTowns: boolean;
    isDisconnected: boolean;
    isError: boolean;
}

Source: useTownsAuthStatus

​
Parameters

​
config

  • Type: ObservableConfig.FromObservable<AuthStatus>
  • Optional

Configuration options for the observable.

​
Return Type

An object containing the current AuthStatus status and boolean flags for each possible status.

{
    status: AuthStatus;
    isInitializing: boolean;
    isEvaluatingCredentials: boolean;
    isCredentialed: boolean;
    isConnectingToTowns: boolean;
    isConnectedToTowns: boolean;
    isDisconnected: boolean;
    isError: boolean;
}

Was this page helpful?