Interface Authentication

Authentication state.

interface Authentication {
    authenticated: boolean;
    getLoginDate(): Date;
    getName(): undefined | string;
    getUser(): undefined | User;
    isAuthenticated(): boolean;
    loginDate: Date;
    logout(): boolean | Promise<boolean>;
    name: undefined | string;
    [key: string]: unknown;
}

Indexable

[key: string]: unknown

may have extra keys

Properties

authenticated loginDate name

Methods

getLoginDate getName getUser isAuthenticated logout

Properties

Readonly authenticated

authenticated: boolean

Please use the () method.

Deprecated

Readonly loginDate

loginDate: Date

Please use the getLoginDate method.

Deprecated

Readonly name

name: undefined | string

Please use the getName method.

Deprecated

Methods

getLoginDate

  • getLoginDate(): Date

  • The date of the login.

    Returns Date

getName

  • getName(): undefined | string

  • Gets the name of the User that this Authentication context was created for.

    Returns undefined | string

getUser

  • getUser(): undefined | User

  • Gets the user instances associated with this authentication.

    Returns undefined | User

isAuthenticated

  • isAuthenticated(): boolean

  • Current authentication state of this context.

    Returns boolean

logout

  • logout(): boolean | Promise<boolean>

  • Logs out the user instances associated with this authentication.

    Returns boolean | Promise<boolean>

Settings

Member Visibility

Theme

On This Page

authenticatedloginDatenamegetLoginDategetNamegetUserisAuthenticatedlogout

Generated using TypeDoc