ic-reactor
    Preparing search index...

    Interface UseAuthReturnType

    The return type for authentication hooks.

    interface UseAuthReturnType {
        error: undefined | Error;
        authenticated: boolean;
        isAuthenticated: boolean;
        authenticating: boolean;
        isAuthenticating: boolean;
        identity: null | types.Identity;
        login: (options?: types.AuthClientLoginOptions) => Promise<void>;
        logout: (options?: LogoutParameters) => Promise<void>;
        authenticate: () => Promise<types.Identity>;
        loginLoading: boolean;
        isLoginLoading: boolean;
        loginError: undefined | string;
    }
    Index

    Properties

    error authenticated isAuthenticated authenticating isAuthenticating identity login logout authenticate loginLoading isLoginLoading loginError

    Properties

    error: undefined | Error

    Any non-login related error that occurred.

    authenticated: boolean

    Use isAuthenticated instead. Indicates whether the user is authenticated.

    isAuthenticated: boolean

    Indicates whether the user is authenticated.

    authenticating: boolean

    Use isAuthenticating instead. Indicates whether an authentication request is in progress.

    isAuthenticating: boolean

    Indicates whether an authentication request is in progress.

    identity: null | types.Identity

    The current identity object, or null if not authenticated.

    login: (options?: types.AuthClientLoginOptions) => Promise<void>

    Initiates the login flow with optional parameters.

    Type declaration

    logout: (options?: LogoutParameters) => Promise<void>

    Logs the user out with optional parameters.

    Type declaration

    authenticate: () => Promise<types.Identity>

    Triggers the authentication flow and resolves to an Identity.

    loginLoading: boolean

    Use isLoginLoading instead. Indicates whether the login operation is in progress.

    isLoginLoading: boolean

    Indicates whether the login operation is in progress.

    loginError: undefined | string

    The error message, if any, occurred during login.

    Settings

    Member Visibility

    On This Page

    Properties