Skip to main content
References

EmailVerification Types

Type Aliases

InputType

type InputType = RecipeConfig<PreAndPostAPIHookAction> & UserInput;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:43

InputTypeOverride

type InputTypeOverride = object;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:29

Properties

PropertyTypeDefined in
functions?(originalImplementation, builder) => RecipeInterfacetmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:30

NormalisedInputType

type NormalisedInputType = NormalisedRecipeConfig<PreAndPostAPIHookAction> & object;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:45

Type Declaration

PostAPIHookContext

type PostAPIHookContext = RecipePreAPIHookContext<PreAndPostAPIHookAction>;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:27

PreAndPostAPIHookAction

type PreAndPostAPIHookAction = "VERIFY_EMAIL" | "SEND_VERIFY_EMAIL" | "IS_EMAIL_VERIFIED";

Defined in: tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:24

PreAPIHookContext

type PreAPIHookContext = RecipePreAPIHookContext<PreAndPostAPIHookAction>;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:26

RecipeInterface

type RecipeInterface = object;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:54

Properties

PropertyTypeDescriptionDefined in
getEmailVerificationTokenFromURL(input) => stringReads and returns the email verification token from the current URLtmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:113
getTenantIdFromURL(input) => string | undefinedReads and returns the tenant id from the current URLtmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:122
isEmailVerified(input) => Promise<{ fetchResponse: Response; isVerified: boolean; status: "OK"; }>Check if an email has been verified Throws STGeneralError if the API exposed by the backend SDKs returns status: "GENERAL_ERROR"tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:100
sendVerificationEmail(input) => Promise<{ fetchResponse: Response; status: "EMAIL_ALREADY_VERIFIED_ERROR" | "OK"; }>Send an email to the user for verification. Throws STGeneralError if the API exposed by the backend SDKs returns status: "GENERAL_ERROR"tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:84
verifyEmail(input) => Promise<{ fetchResponse: Response; status: "OK" | "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"; }>Verify an email Throws STGeneralError if the API exposed by the backend SDKs returns status: "GENERAL_ERROR"tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:67

UserInput

type UserInput = object & RecipeModuleUserInput<PreAndPostAPIHookAction>;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:36

Type Declaration