Interface AuthState

Represents the authentication state of an agent.

interface AuthState {
    identity: null | types.Identity;
    authenticating: boolean;
    isAuthenticating: boolean;
    authenticated: boolean;
    isAuthenticated: boolean;
    error: undefined | Error;
}

Properties

identity: null | types.Identity

authenticating: boolean

Use isAuthenticating instead. Indicates whether the authentication process is ongoing.

isAuthenticating: boolean

Indicates whether the authentication process is ongoing.

authenticated: boolean

Use isAuthenticated instead. Indicates whether the agent is authenticated.

isAuthenticated: boolean

Indicates whether the agent is authenticated.

error: undefined | Error

Represents any error that occurred during authentication.