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

Index

References

EmailPasswordAuth

Renames and re-exports __type

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" }

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 }

UserInput

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

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" }): void

Const signOut

  • signOut(): Promise<void>

Generated using TypeDoc