Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EmailPasswordProviderOptions

Hierarchy

  • EmailPasswordProviderOptions

Index

Properties

Properties

Optional autoRegister

autoRegister: boolean

Optional getResetPasswordToken

getResetPasswordToken: (user: User) => Promise<string>

Generate custom reset password token

Type declaration

    • (user: User): Promise<string>

    • Parameters

      Returns Promise<string>

getUserByEmail

getUserByEmail: (email: string, req: any) => Promise<undefined | (User & { password: string })>

Type declaration

    • (email: string, req: any): Promise<undefined | (User & { password: string })>

    • Parameters

      • email: string
      • req: any

      Returns Promise<undefined | (User & { password: string })>

Optional passwordHashingAlgorithm

passwordHashingAlgorithm: HashingAlgorithm

Optional saveNonExistingUser

saveNonExistingUser: (data: UserInfo, hashedPassword: string, req: any) => Promise<User>

Type declaration

    • (data: UserInfo, hashedPassword: string, req: any): Promise<User>

    • Parameters

      • data: UserInfo
      • hashedPassword: string
      • req: any

      Returns Promise<User>

Optional saveResetPasswordToken

saveResetPasswordToken: (token: string, user: User, req?: any) => Promise<void>

Type declaration

    • (token: string, user: User, req?: any): Promise<void>

    • Parameters

      • token: string
      • user: User
      • Optional req: any

      Returns Promise<void>

Optional sendResetPasswordEmail

sendResetPasswordEmail: (resetToken: string, user: User, req: any) => Promise<void>

Type declaration

    • (resetToken: string, user: User, req: any): Promise<void>

    • Parameters

      • resetToken: string
      • user: User
      • req: any

      Returns Promise<void>

Optional updatePassword

updatePassword: (hashedPassword: string, user: User, req?: any) => Promise<void>

Type declaration

    • (hashedPassword: string, user: User, req?: any): Promise<void>

    • Parameters

      • hashedPassword: string
      • user: User
      • Optional req: any

      Returns Promise<void>

Optional validatePassword

validatePassword: (password: string, req?: any) => Promise<void>

Do custom validation of the changed password before the updatePassword function is called eg. is password longer then 8 characters

Type declaration

    • (password: string, req?: any): Promise<void>

    • Parameters

      • password: string
      • Optional req: any

      Returns Promise<void>

Optional validateResetPasswordToken

validateResetPasswordToken: (token: string, req?: any) => Promise<undefined | User>

Do custom reset password token validation before the password is changed (before the updatePassword function is called) eg. check if the token is expired

Type declaration

    • (token: string, req?: any): Promise<undefined | User>

    • Parameters

      • token: string
      • Optional req: any

      Returns Promise<undefined | User>

Optional validateSignIn

validateSignIn: (email: string, password: string, req: any) => Promise<void>

Do custom sign-in validation steps eg. check number of login attempts etc.

Type declaration

    • (email: string, password: string, req: any): Promise<void>

    • Parameters

      • email: string
      • password: string
      • req: any

      Returns Promise<void>

Optional validateUser

validateUser: (data: UserInfo, password: string, req: any) => Promise<void>

Validate user before the saveNonExistingUser function is called

Type declaration

    • (data: UserInfo, password: string, req: any): Promise<void>

    • Parameters

      • data: UserInfo
      • password: string
      • req: any

      Returns Promise<void>

Generated using TypeDoc