Class BaseForgotPasswordStore

A ForgotPasswordStore using an ExpiringStorage to hold the necessary records.

Hierarchy

BaseForgotPasswordStore

Implements

ForgotPasswordStore

Index

Constructors

Properties

Methods

delete generate get

Constructors

constructor

new BaseForgotPasswordStore(storage, ttl?): BaseForgotPasswordStore
Parameters
- storage: ExpiringStorage<string, string>
- ttl: number = 15
Returns BaseForgotPasswordStore
- Defined in src/identity/interaction/password/util/BaseForgotPasswordStore.ts:12

Properties

`Private` `Readonly` storage

storage: ExpiringStorage<string, string>

`Private` `Readonly` ttl

ttl: number

Methods

delete

delete(recordId): Promise<boolean>
Deletes the Forgot Password Confirmation Record.
Parameters
- recordId: string
  
  The record id of the forgot password confirmation record.
Returns Promise<boolean>
Implementation of ForgotPasswordStore.delete
- Defined in src/identity/interaction/password/util/BaseForgotPasswordStore.ts:27

generate

generate(email): 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
- email: string
  
  ID of the email/password login object.
Returns Promise<string>
The record id. This should be included in the reset password link.
Implementation of ForgotPasswordStore.generate
- Defined in src/identity/interaction/password/util/BaseForgotPasswordStore.ts:17

get

get(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.
Implementation of ForgotPasswordStore.get
- Defined in src/identity/interaction/password/util/BaseForgotPasswordStore.ts:23