EmailVerification Types

Type Aliases

ComponentOverrideMap

type ComponentOverrideMap = object;

Defined in: recipe/emailverification/types.ts:27

Properties

Property	Type	Defined in
EmailVerificationSendVerifyEmail_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/emailverification/types.ts:28
EmailVerificationVerifyEmailLinkClicked_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/emailverification/types.ts:29

Config

type Config = UserInput & RecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;

Defined in: recipe/emailverification/types.ts:48

EmailVerificationThemeProps

type EmailVerificationThemeProps = object;

Defined in: recipe/emailverification/types.ts:82

Properties

Property	Type	Defined in
config	NormalisedConfig	recipe/emailverification/types.ts:85
sendVerifyEmailScreen	SendVerifyEmailThemeProps	recipe/emailverification/types.ts:83
userContext?	UserContext	recipe/emailverification/types.ts:86
verifyEmailLinkClickedScreen?	VerifyEmailLinkClickedThemeProps	recipe/emailverification/types.ts:84

GetRedirectionURLContext

type GetRedirectionURLContext = NormalisedGetRedirectionURLContext<{
  action: "VERIFY_EMAIL";
}>;

Defined in: recipe/emailverification/types.ts:64

NormalisedConfig

type NormalisedConfig = object & NormalisedRecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;

Defined in: recipe/emailverification/types.ts:51

Type Declaration

Name	Type	Defined in
disableDefaultUI	boolean	recipe/emailverification/types.ts:53
mode	"OPTIONAL" | "REQUIRED"	recipe/emailverification/types.ts:52
override	object	recipe/emailverification/types.ts:56
override.functions()	(originalImplementation, builder) => SuperTokensWrapper	recipe/emailverification/types.ts:57
sendVerifyEmailScreen	FeatureBaseConfig	recipe/emailverification/types.ts:54
verifyEmailLinkClickedScreen	FeatureBaseConfig	recipe/emailverification/types.ts:55

OnHandleEventContext

type OnHandleEventContext = object;

Defined in: recipe/emailverification/types.ts:77

Properties

Property	Type	Defined in
action	"VERIFY_EMAIL_SENT" | "EMAIL_VERIFIED_SUCCESSFUL"	recipe/emailverification/types.ts:78
userContext	UserContext	recipe/emailverification/types.ts:79

PreAndPostAPIHookAction

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

Defined in: recipe/emailverification/types.ts:68

PreAPIHookContext

type PreAPIHookContext = object;

Defined in: recipe/emailverification/types.ts:70

Properties

Property	Type	Defined in
action	PreAndPostAPIHookAction	recipe/emailverification/types.ts:71
requestInit	RequestInit	recipe/emailverification/types.ts:72
url	string	recipe/emailverification/types.ts:73
userContext	UserContext	recipe/emailverification/types.ts:74

SendVerifyEmailThemeProps

type SendVerifyEmailThemeProps = ThemeBaseProps & object;

Defined in: recipe/emailverification/types.ts:89

Type Declaration

Name	Type	Defined in
config	NormalisedConfig	recipe/emailverification/types.ts:91
onEmailAlreadyVerified()	() => Promise<void>	recipe/emailverification/types.ts:93
recipeImplementation	SuperTokensWrapper	recipe/emailverification/types.ts:90
redirectToAuth()	() => Promise<void>	recipe/emailverification/types.ts:94
signOut()	() => Promise<void>	recipe/emailverification/types.ts:92

UserInput

type UserInput = object & RecipeModuleUserInput<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;

Defined in: recipe/emailverification/types.ts:33

Type Declaration

Name	Type	Defined in
disableDefaultUI?	boolean	recipe/emailverification/types.ts:35
mode?	"OPTIONAL" | "REQUIRED"	recipe/emailverification/types.ts:34
override?	object	recipe/emailverification/types.ts:39
override.functions()?	(originalImplementation, builder) => SuperTokensWrapper	recipe/emailverification/types.ts:40
sendVerifyEmailScreen?	FeatureBaseConfig	recipe/emailverification/types.ts:36
verifyEmailLinkClickedScreen?	FeatureBaseConfig	recipe/emailverification/types.ts:37

VerifyEmailLinkClickedThemeProps

type VerifyEmailLinkClickedThemeProps = ThemeBaseProps & object;

Defined in: recipe/emailverification/types.ts:97

Type Declaration

Name	Type	Defined in
config	NormalisedConfig	recipe/emailverification/types.ts:99
onSuccess()	() => Promise<void>	recipe/emailverification/types.ts:100
onTokenInvalidRedirect()	() => Promise<void>	recipe/emailverification/types.ts:101
recipeImplementation	SuperTokensWrapper	recipe/emailverification/types.ts:98
token	string	recipe/emailverification/types.ts:102