These are the SDK reference docs. If you’re looking for docs to implement SuperTokens, you might want to check out the User Guides

Hierarchy

  • RecipeInterface

Index

Methods

createEmailVerificationToken

  • createEmailVerificationToken(input: { email: string; userId: string }): Promise<{ status: "OK"; token: string } | { status: "EMAIL_ALREADY_VERIFIED_ERROR" }>
  • Parameters

    • input: { email: string; userId: string }
      • email: string
      • userId: string

    Returns Promise<{ status: "OK"; token: string } | { status: "EMAIL_ALREADY_VERIFIED_ERROR" }>

isEmailVerified

  • isEmailVerified(input: { email: string; userId: string }): Promise<boolean>

revokeEmailVerificationTokens

  • revokeEmailVerificationTokens(input: { email: string; userId: string }): Promise<{ status: "OK" }>

unverifyEmail

  • unverifyEmail(input: { email: string; userId: string }): Promise<{ status: "OK" }>

verifyEmailUsingToken

  • verifyEmailUsingToken(input: { token: string }): Promise<{ status: "OK"; user: User } | { status: "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR" }>

Generated using TypeDoc