Interface IAuthService

Interface for the AuthService class

interface IAuthService {
    deleteUser(email: string): Promise<DeleteResult>;
    loginUser(email: string, password: string): Promise<IUser>;
    registerUser(email: string, password: string): Promise<Document<unknown, any, any>>;
}

Implemented by

Methods

deleteUser loginUser registerUser

Methods

deleteUser

  • deleteUser(email): Promise<DeleteResult>

  • Deletes a user

    Parameters

    • email: string

      The email of the user

    Returns Promise<DeleteResult>

    The result of the deletion

loginUser

  • loginUser(email, password): Promise<IUser>

  • Logs in a user

    Parameters

    • email: string

      The email of the user

    • password: string

      The password of the user

    Returns Promise<IUser>

    The logged in user

    Throws

    If the credentials are invalid

registerUser

  • registerUser(email, password): Promise<Document<unknown, any, any>>

  • Registers a new user

    Parameters

    • email: string

      The email of the user

    • password: string

      The password of the user

    Returns Promise<Document<unknown, any, any>>

    The created user

    Throws

    If the user already exists

Settings

Member Visibility

On This Page

Methods