Class UserService

User table service.

Hierarchy

UserService

Index

Constructors

constructor

new UserService(dbService: DBService, resourceService: ResourceService, imageService: ImageService, sessionService: SessionService): UserService

- Defined in src/services/user/user.service.ts:29
Parameters
- dbService: DBService
- resourceService: ResourceService
- imageService: ImageService
- sessionService: SessionService
Returns UserService

Methods

addMoneyMade

addMoneyMade(userID: string, amount: number): Promise<NBUser>

- Defined in src/services/user/user.service.ts:347
Increment the amount of money a user has made.

Parameters
- userID: string
  
  The user's ID.
- amount: number
  
  The amount of money to add.
Returns Promise<NBUser>

The updated user record.

createUser

createUser(firstname: string, lastname: string, email: string, password: string): Promise<NBUser>

- Defined in src/services/user/user.service.ts:49
Create a new user.

Parameters
- firstname: string
  
  The user's first name.
- lastname: string
  
  The user's last name.
- email: string
  
  The user's email address.
- password: string
  
  The user's password.
Returns Promise<NBUser>

The new user record.

deleteUser

deleteUser(userID: string): Promise<void>

- Defined in src/services/user/user.service.ts:424
Delete a user.

Parameters
- userID: string
  
  The user's ID.
Returns Promise<void>

deleteUserImage

deleteUserImage(userID: string): Promise<NBUser>

- Defined in src/services/user/user.service.ts:296
Delete a user's image.

Parameters
- userID: string
  
  The user's ID.
Returns Promise<NBUser>

The updated user record.

getCurrentBooks

getCurrentBooks(userID: string): Promise<NBBook[]>

- Defined in src/services/user/user.service.ts:189
Get the books currently listed by a user.

Parameters
- userID: string
  
  The user's ID.
Returns Promise<NBBook[]>

All books currently listed by the user.

getUser

getUser(userID: string): Promise<NBUser>

- Defined in src/services/user/user.service.ts:155
Get a user.

Parameters
- userID: string
  
  The user's ID.
Returns Promise<NBUser>

The user record.

getUserByEmail

getUserByEmail(email: string): Promise<NBUser>

- Defined in src/services/user/user.service.ts:171
Get a user given an email address.

Parameters
- email: string
  
  The user's email address.
Returns Promise<NBUser>

The user record.

Private hashPassword

hashPassword(password: string): Promise<string>

- Defined in src/services/user/user.service.ts:448
Hash a password.

Parameters
- password: string
  
  The password.
Returns Promise<string>

The hashed password.

incrementBooksListed

incrementBooksListed(userID: string, num?: number): Promise<NBUser>

- Defined in src/services/user/user.service.ts:317
Increment the number of books a user has listed.

Parameters
- userID: string
  
  The user's ID.
- num: number = 1
  
  The number to increment by.
Returns Promise<NBUser>

The updated user record.

incrementBooksSold

incrementBooksSold(userID: string, num?: number): Promise<NBUser>

- Defined in src/services/user/user.service.ts:332
Increment the number of books a user has sold.

Parameters
- userID: string
  
  The user's ID.
- num: number = 1
  
  The number to increment by.
Returns Promise<NBUser>

The updated user record.

login

login(email: string, password: string): Promise<NBSession>

- Defined in src/services/user/user.service.ts:392
Log a user in and return the new session.

Parameters
- email: string
  
  The user's email address.
- password: string
  
  The user's password.
Returns Promise<NBSession>

The new user session.

Private passwordMatch

passwordMatch(password: string, hash: string): Promise<boolean>

- Defined in src/services/user/user.service.ts:463
Check if passwords match.

Parameters
- password: string
  
  The password.
- hash: string
  
  The hashed password.
Returns Promise<boolean>

Whether or not the password and hash match.

pruneUnverifiedUsers

pruneUnverifiedUsers(): Promise<void>

- Defined in src/services/user/user.service.ts:432
Prune all old unverified accounts.

Returns Promise<void>

recommendations

recommendations(userID: string): Promise<NBBook[]>

- Defined in src/services/user/user.service.ts:361
Get a list of books recommended to the user.

Parameters
- userID: string
  
  The user's ID.
Returns Promise<NBBook[]>

The list of recommended books.

setPassword

setPassword(userID: string, newPassword: string): Promise<NBUser>

- Defined in src/services/user/user.service.ts:210
Set a user's password.

Parameters
- userID: string
  
  The user's ID.
- newPassword: string
  
  The new password.
Returns Promise<NBUser>

The updated user record.

setUserImage

setUserImage(userID: string, imageData: string): Promise<NBUser>

- Defined in src/services/user/user.service.ts:271
Set a user's image.

Parameters
- userID: string
  
  The user's ID.
- imageData: string
  
  The image data.
Returns Promise<NBUser>

The updated user record.

setVerified

setVerified(userID: string, verified?: boolean): Promise<NBUser>

- Defined in src/services/user/user.service.ts:252
Set a user's verified status.

Parameters
- userID: string
  
  The user's ID.
- verified: boolean = true
  
  The new verified status.
Returns Promise<NBUser>

The updated user record.

userExists

userExists(userID: string): Promise<boolean>

- Defined in src/services/user/user.service.ts:132
Determine whether or not a user exists.

Parameters
- userID: string
  
  The ID of the user.
Returns Promise<boolean>

Whether or not the user exists.

userExistsByEmail

userExistsByEmail(email: string): Promise<boolean>

- Defined in src/services/user/user.service.ts:142
Determine whether or not a user with a given email address exists.

Parameters
- email: string
  
  The user's email.
Returns Promise<boolean>

Whether or not a user with the given email address exists.

Generated using TypeDoc