Class PasswordResetService

Password reset services.

Hierarchy

BaseService
- PasswordResetService

Constructors

constructor

Properties

dbm

Methods

Constructors

constructor

new PasswordResetService(dbm: default): PasswordResetService

Inherited from BaseService.constructor
- Defined in services/util.ts:98
Parameters
- dbm: default
Returns PasswordResetService

Properties

Readonly dbm

Methods

deleteResetRecord

deleteResetRecord(resetID: string): Promise<void>

- Defined in services/passwordReset.ts:126
Delete a password reset record.

Parameters
- resetID: string
  
  A password reset record's ID.
Returns Promise<void>

getResetRecord

getResetRecord(resetID: string): Promise<PasswordReset>

- Defined in services/passwordReset.ts:113
Get a password reset record.

Parameters
- resetID: string
  
  A password reset record's ID.
Returns Promise<PasswordReset>

The password reset record.

requestPasswordReset

requestPasswordReset(email: string, prune?: boolean): Promise<string>

- Defined in services/passwordReset.ts:41
Request a password reset.

Parameters
- email: string
  
  The email address associated with the user's account.
- prune: boolean = true
  
  Whether or not to prune the record when the time comes.
Returns Promise<string>

The new password reset record's ID.

resetPassword

resetPassword(resetID: string, newPassword: string): Promise<boolean>

- Defined in services/passwordReset.ts:139
Reset a user's password.

Parameters
- resetID: string
  
  A password reset record's ID.
- newPassword: string
  
  The user's new password.
Returns Promise<boolean>

Whether or not the reset was successful.

resetRecordExists

resetRecordExists(resetID: string): Promise<boolean>

- Defined in services/passwordReset.ts:99
Check if a password reset record exists.

Parameters
- resetID: string
  
  A password reset record's ID.
Returns Promise<boolean>

Whether or not the password reset record exists.

Generated using TypeDoc