@river-build/react-sdk/dist/types/useRiverAuthStatus.d.ts

React Hooks for River SDK

import { AuthStatus } from '@river-build/sdk';
import type { ObservableConfig } from './useObservable';
/**
 * Hook to get the auth status of the user connection with the River network.
 * @param config - Configuration options for the observable.
 * @returns An object containing the current AuthStatus status and boolean flags for each possible status.
 */
export declare const useRiverAuthStatus: (config?: ObservableConfig.FromObservable<AuthStatus>) => {
    /** The current AuthStatus of the user connection with the River network. */
    status: AuthStatus;
    /** Whether the user connection with the River network is initializing. */
    isInitializing: boolean;
    /** Whether the user connection with the River network is evaluating credentials. */
    isEvaluatingCredentials: boolean;
    /** Whether the user connection with the River network is credentialed. */
    isCredentialed: boolean;
    /** Whether the user connection with the River network is connecting to River. */
    isConnectingToRiver: boolean;
    /** Whether the user connection with the River network is connected to River. */
    isConnectedToRiver: boolean;
    /** Whether the user connection with the River network is disconnected. */
    isDisconnected: boolean;
    /** Whether the user connection with the River network is in an error state. */
    isError: boolean;
};
//# sourceMappingURL=useRiverAuthStatus.d.ts.map