Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Module recipe/emailpassword

Index

References

Classes

Type aliases

Variables

Functions

References

EmailVerificationTheme

Renames and re-exports __type

ResetPasswordUsingTokenTheme

Renames and re-exports __type

SignInAndUpTheme

Renames and re-exports __type

Type aliases

GetRedirectionURLContext

GetRedirectionURLContext: AuthRecipeModuleGetRedirectionURLContext | { action: "RESET_PASSWORD" }

OnHandleEventContext

OnHandleEventContext: AuthRecipeModuleOnHandleEventContext | { action: "RESET_PASSWORD_EMAIL_SENT" | "PASSWORD_RESET_SUCCESSFUL" } | { action: "SUCCESS"; isNewUser: boolean; user: { email: string; id: string } }

PreAPIHookContext

PreAPIHookContext: AuthRecipeModulePreAPIHookContext | { action: "EMAIL_PASSWORD_SIGN_UP" | "EMAIL_PASSWORD_SIGN_IN" | "SEND_RESET_PASSWORD_EMAIL" | "SUBMIT_NEW_PASSWORD" | "EMAIL_EXISTS"; requestInit: RequestInit; url: string }

RecipeInterface

RecipeInterface: { doesEmailExist: any; sendPasswordResetEmail: any; signIn: any; signUp: any; submitNewPassword: any }

Type declaration

  • doesEmailExist:function
    • doesEmailExist(input: { config: NormalisedConfig; email: string }): Promise<boolean>
  • sendPasswordResetEmail:function
    • sendPasswordResetEmail(input: { config: NormalisedConfig; formFields: { id: string; value: string }[] }): Promise<{ status: "OK" } | { formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>

    • Parameters

      • input: { config: NormalisedConfig; formFields: { id: string; value: string }[] }
        • config: NormalisedConfig
        • formFields: { id: string; value: string }[]

      Returns Promise<{ status: "OK" } | { formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>

  • signIn:function
    • signIn(input: { config: NormalisedConfig; formFields: { id: string; value: string }[] }): Promise<{ status: "OK"; user: User } | { formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { status: "WRONG_CREDENTIALS_ERROR" }>

    • Parameters

      • input: { config: NormalisedConfig; formFields: { id: string; value: string }[] }
        • config: NormalisedConfig
        • formFields: { id: string; value: string }[]

      Returns Promise<{ status: "OK"; user: User } | { formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { status: "WRONG_CREDENTIALS_ERROR" }>

  • signUp:function
    • signUp(input: { config: NormalisedConfig; formFields: { id: string; value: string }[] }): Promise<{ status: "OK"; user: User } | { formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>

    • Parameters

      • input: { config: NormalisedConfig; formFields: { id: string; value: string }[] }
        • config: NormalisedConfig
        • formFields: { id: string; value: string }[]

      Returns Promise<{ status: "OK"; user: User } | { formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>

  • submitNewPassword:function
    • submitNewPassword(input: { config: NormalisedConfig; formFields: { id: string; value: string }[]; token: string }): Promise<{ status: "OK" | "RESET_PASSWORD_INVALID_TOKEN_ERROR" } | { formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>

    • Parameters

      • input: { config: NormalisedConfig; formFields: { id: string; value: string }[]; token: string }
        • config: NormalisedConfig
        • formFields: { id: string; value: string }[]
        • token: string

      Returns Promise<{ status: "OK" | "RESET_PASSWORD_INVALID_TOKEN_ERROR" } | { formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>

UserInput

UserInput: { override?: { components?: ComponentOverrideMap; functions?: any } & AuthRecipeUserInputOverride; resetPasswordUsingTokenFeature?: ResetPasswordUsingTokenUserInput; signInAndUpFeature?: SignInAndUpFeatureUserInput } & AuthRecipeModuleUserInput<GetRedirectionURLContext, PreAPIHookContext, OnHandleEventContext>

Variables

EmailPasswordAuth

EmailPasswordAuth: React.FC<PropsWithChildren<{ requireAuth?: boolean; onSessionExpired?: any }>> = ...

Functions

Const EmailVerification

  • EmailVerification(prop?: any): Element

Const ResetPasswordUsingToken

  • ResetPasswordUsingToken(prop?: any): Element

Const SignInAndUp

  • SignInAndUp(prop?: any): Element

Const init

Const isEmailVerified

  • isEmailVerified(): Promise<boolean>

Const redirectToAuth

  • redirectToAuth(input?: "signin" | "signup" | { redirectBack?: false | true; show?: "signin" | "signup" }): Promise<void>

Const signOut

  • signOut(): Promise<void>

Generated using TypeDoc