Interface ForgotPasswordStore

Responsible for storing the records that are used when a user forgets their password.

Hierarchy

ForgotPasswordStore

Implemented by

BaseForgotPasswordStore

Index

Properties

delete generate get

Properties

delete

delete: ((recordId) => Promise<boolean>)

Type declaration

- (recordId): Promise<boolean>
- Deletes the Forgot Password Confirmation Record.
  Parameters
  - recordId: string
    
    The record id of the forgot password confirmation record.
  Returns Promise<boolean>

generate

generate: ((id) => Promise<string>)

Type declaration

- (id): Promise<string>
- Creates a Forgot Password Confirmation Record. This will be to remember that a user has made a request to reset a password. Throws an error if the email doesn't exist.
  Parameters
  - id: string
    
    ID of the email/password login object.
  Returns Promise<string>
  The record id. This should be included in the reset password link.

get

get: ((recordId) => Promise<undefined | string>)

Type declaration

- (recordId): Promise<undefined | string>
- Gets the email associated with the forgot password confirmation record or undefined if it's not present.
  Parameters
  - recordId: string
    
    The record id retrieved from the link.
  Returns Promise<undefined | string>
  The user's email.