supertokens-web-js/recipe/emailverification/types
References documentation for the supertokens-web-js/recipe/emailverification/types package
Type Aliases
InputType
type InputType = RecipeConfig<PreAndPostAPIHookAction> & UserInput;Defined in: tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts
InputTypeOverride
type InputTypeOverride = object;Defined in: tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts
Properties
| Property | Type | Defined in |
|---|---|---|
functions? |
(originalImplementation, builder) => RecipeInterface |
tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts |
NormalisedInputType
type NormalisedInputType = NormalisedRecipeConfig<PreAndPostAPIHookAction> & object;Defined in: tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts
Type Declaration
| Name | Type | Defined in |
|---|---|---|
override |
object |
tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts |
override.functions() |
(originalImplementation, builder) => RecipeInterface |
tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts |
PostAPIHookContext
type PostAPIHookContext = RecipePreAPIHookContext<PreAndPostAPIHookAction>;Defined in: tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts
PreAndPostAPIHookAction
type PreAndPostAPIHookAction = "VERIFY_EMAIL" | "SEND_VERIFY_EMAIL" | "IS_EMAIL_VERIFIED";Defined in: tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts
PreAPIHookContext
type PreAPIHookContext = RecipePreAPIHookContext<PreAndPostAPIHookAction>;Defined in: tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts
RecipeInterface
type RecipeInterface = object;Defined in: tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
getEmailVerificationTokenFromURL |
(input) => string |
Reads and returns the email verification token from the current URL | tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts |
getTenantIdFromURL |
(input) => string | undefined |
Reads and returns the tenant id from the current URL | tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts |
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 |
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 |
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 |
UserInput
type UserInput = object & RecipeModuleUserInput<PreAndPostAPIHookAction>;Defined in: tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts
Type Declaration
| Name | Type | Description | Defined in |
|---|---|---|---|
override? |
InputTypeOverride |
Refer to the documentation | tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts |