Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VerifyService

Verification services.

Hierarchy

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly dbm

dbm: default

Methods

createVerifyRecord

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

  • Create a user verification record.

    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 verification record's ID.

deleteUnverifiedUser

  • deleteUnverifiedUser(verifyID: string): Promise<void>

  • Delete a verification record and the corresponding user.

    Parameters

    • verifyID: string

      A verification record's ID.

    Returns Promise<void>

deleteVerifyRecord

  • deleteVerifyRecord(verifyID: string): Promise<void>

  • Delete a verification record.

    Parameters

    • verifyID: string

      A verification record's ID.

    Returns Promise<void>

getVerifyRecord

  • getVerifyRecord(verifyID: string): Promise<Verify>

  • Get a verification record.

    Parameters

    • verifyID: string

      A verification record's ID.

    Returns Promise<Verify>

    The verification record.

verifyRecordExists

  • verifyRecordExists(verifyID: string): Promise<boolean>

  • Check if a verification record exists.

    Parameters

    • verifyID: string

      A verification record's ID.

    Returns Promise<boolean>

    Whether or not the verification record exists.

verifyUser

  • verifyUser(verifyID: string): Promise<boolean>

  • Verify a user.

    Parameters

    • verifyID: string

      A verification record's ID.

    Returns Promise<boolean>

    Whether or not the verification was successful.

Generated using TypeDoc