Class AuthService

Hierarchy (View Summary, Expand)

Constructors

constructor

Methods

authenticate boot provisionToken getName

Constructors

constructor

Properties

Protected Readonlyapplication

application: Application

Protected Readonlyclient

client: BaseClient

Protected Readonlylogger

logger: Logger

Protected Staticname

name: string

Returns the name of the function. Function names are read-only and can not be changed.

Methods

authenticate

  • authenticate(
        credentials: AuthCredentials,
    ): Promise<
        | { success: false }
        | {
            success: true;
            user: {
                createdAt: Date;
                discordId: string;
                githubId: null | string;
                guilds: string[];
                id: number;
                name: null | string;
                password: string;
                recoveryAttempts: number;
                recoveryCode: null | string;
                recoveryToken: null | string;
                recoveryTokenExpiresAt: null | Date;
                token: null | string;
                tokenExpiresAt: null | Date;
                updatedAt: Date;
                username: string;
            };
        },
    >

    Parameters

    • credentials: AuthCredentials

    Returns Promise<
        | { success: false }
        | {
            success: true;
            user: {
                createdAt: Date;
                discordId: string;
                githubId: null | string;
                guilds: string[];
                id: number;
                name: null | string;
                password: string;
                recoveryAttempts: number;
                recoveryCode: null | string;
                recoveryToken: null | string;
                recoveryTokenExpiresAt: null | Date;
                token: null | string;
                tokenExpiresAt: null | Date;
                updatedAt: Date;
                username: string;
            };
        },
    >

boot

provisionToken

  • provisionToken(
        user: {
            createdAt: Date;
            discordId: string;
            githubId: null | string;
            guilds: string[];
            id: number;
            name: null | string;
            password: string;
            recoveryAttempts: number;
            recoveryCode: null | string;
            recoveryToken: null | string;
            recoveryTokenExpiresAt: null | Date;
            token: null | string;
            tokenExpiresAt: null | Date;
            updatedAt: Date;
            username: string;
        },
    ): Promise<string>

    Parameters

    • user: {
          createdAt: Date;
          discordId: string;
          githubId: null | string;
          guilds: string[];
          id: number;
          name: null | string;
          password: string;
          recoveryAttempts: number;
          recoveryCode: null | string;
          recoveryToken: null | string;
          recoveryTokenExpiresAt: null | Date;
          token: null | string;
          tokenExpiresAt: null | Date;
          updatedAt: Date;
          username: string;
      }

    Returns Promise<string>

StaticgetName

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR