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

EmailVerificationTheme

Renames and re-exports __type

SignInAndUpTheme

Renames and re-exports __type

ThirdPartyAuth

Renames and re-exports __type

Type aliases

GetRedirectionURLContext

GetRedirectionURLContext: AuthRecipeModuleGetRedirectionURLContext

OnHandleEventContext

OnHandleEventContext: AuthRecipeModuleOnHandleEventContext

PreAPIHookContext

PreAPIHookContext: AuthRecipeModulePreAPIHookContext | { action: "GET_AUTHORISATION_URL"; requestInit: RequestInit; url: string } | { action: "THIRD_PARTY_SIGN_IN_UP"; requestInit: RequestInit; url: string }

UserInput

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

Functions

Const EmailVerification

  • EmailVerification(prop?: any): Element

Const SignInAndUp

  • SignInAndUp(prop?: any): Element

Const init

  • init(config: UserInput): CreateRecipeFunction<GetRedirectionURLContext, PreAPIHookContext, OnHandleEventContext, NormalisedConfig>

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