Class SecureUserService

Hierarchy

  • SecureUserService

Constructors

Properties

Methods

  • Create a new user

    Parameters

    Returns Promise<GetResult<{
        createdAt: Date;
        deletedAt: Date;
        email: string;
        id: number;
        password: string;
        resetToken: string;
        resetTokenExpiration: Date;
        updatedAt: Date;
    }, unknown> & {}>

    • The newly created user.

    Throws

    • Invalid email or password, or user already exists.
  • Deactivate user by ID

    Parameters

    • id: number

      The ID of the user to deactivate.

    Returns Promise<void>

    Throws

    • User already deactivated.

    Throws

    • User not found.
  • Delete user by ID

    Parameters

    • id: number

      The ID of the user to delete.

    Returns Promise<GetResult<{
        createdAt: Date;
        deletedAt: Date;
        email: string;
        id: number;
        password: string;
        resetToken: string;
        resetTokenExpiration: Date;
        updatedAt: Date;
    }, unknown> & {}>

    • The deleted user.

    Throws

    • User not found.
  • Find user by email

    Parameters

    • email: string

      The email of the user to find.

    Returns Promise<GetResult<{
        createdAt: Date;
        deletedAt: Date;
        email: string;
        id: number;
        password: string;
        resetToken: string;
        resetTokenExpiration: Date;
        updatedAt: Date;
    }, unknown> & {}>

    • The requested user.

    Throws

    • User not found.
  • Get user by ID

    Parameters

    • id: number

      The ID of the user to retrieve.

    Returns Promise<GetResult<{
        createdAt: Date;
        deletedAt: Date;
        email: string;
        id: number;
        password: string;
        resetToken: string;
        resetTokenExpiration: Date;
        updatedAt: Date;
    }, unknown> & {}>

    • The requested user.

    Throws

    • User not found.
  • Get all users

    Returns Promise<(GetResult<{
        createdAt: Date;
        deletedAt: Date;
        email: string;
        id: number;
        password: string;
        resetToken: string;
        resetTokenExpiration: Date;
        updatedAt: Date;
    }, unknown> & {})[]>

    • A list of all active users.
  • Reactivate user by ID

    Parameters

    • id: number

      The ID of the user to reactivate.

    Returns Promise<void>

    Throws

    • User already activated.

    Throws

    • User not found.
  • Update user by ID

    Parameters

    • id: number

      The ID of the user to update.

    • updateUserDto: UpdateUserDto

      User data to update.

    Returns Promise<GetResult<{
        createdAt: Date;
        deletedAt: Date;
        email: string;
        id: number;
        password: string;
        resetToken: string;
        resetTokenExpiration: Date;
        updatedAt: Date;
    }, unknown> & {}>

    • The updated user.

    Throws

    • Invalid email or password, or password is the same as the previous password.

    Throws

    • User not found.

Generated using TypeDoc