supertokens-auth-react/recipe/emailverification/types

References documentation for the supertokens-auth-react/recipe/emailverification/types package

Type Aliases

type ComponentOverrideMap = object;

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

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

type EmailVerificationThemeProps = object;

Property	Type	Defined in
`config`	`NormalisedConfig`	recipe/emailverification/types.ts
`sendVerifyEmailScreen`	`SendVerifyEmailThemeProps`	recipe/emailverification/types.ts
`userContext?`	`UserContext`	recipe/emailverification/types.ts
`verifyEmailLinkClickedScreen?`	`VerifyEmailLinkClickedThemeProps`	recipe/emailverification/types.ts

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

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

Name	Type	Defined in
`disableDefaultUI`	`boolean`	recipe/emailverification/types.ts
`mode`	`"OPTIONAL"` \| `"REQUIRED"`	recipe/emailverification/types.ts
`override`	`object`	recipe/emailverification/types.ts
`override.functions()`	(`originalImplementation`, `builder`) => `SuperTokensWrapper`	recipe/emailverification/types.ts
`sendVerifyEmailScreen`	`FeatureBaseConfig`	recipe/emailverification/types.ts
`verifyEmailLinkClickedScreen`	`FeatureBaseConfig`	recipe/emailverification/types.ts

type OnHandleEventContext = object;

Property	Type	Defined in
`action`	`"VERIFY_EMAIL_SENT"` \| `"EMAIL_VERIFIED_SUCCESSFUL"`	recipe/emailverification/types.ts
`userContext`	`UserContext`	recipe/emailverification/types.ts

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

type PreAPIHookContext = object;

Property	Type	Defined in
`action`	`PreAndPostAPIHookAction`	recipe/emailverification/types.ts
`requestInit`	`RequestInit`	recipe/emailverification/types.ts
`url`	`string`	recipe/emailverification/types.ts
`userContext`	`UserContext`	recipe/emailverification/types.ts

type SendVerifyEmailThemeProps = ThemeBaseProps & object;

Name	Type	Defined in
`config`	`NormalisedConfig`	recipe/emailverification/types.ts
`onEmailAlreadyVerified()`	() => `Promise`<`void`>	recipe/emailverification/types.ts
`recipeImplementation`	`SuperTokensWrapper`	recipe/emailverification/types.ts
`redirectToAuth()`	() => `Promise`<`void`>	recipe/emailverification/types.ts
`signOut()`	() => `Promise`<`void`>	recipe/emailverification/types.ts

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

Name	Type	Defined in
`disableDefaultUI?`	`boolean`	recipe/emailverification/types.ts
`mode?`	`"OPTIONAL"` \| `"REQUIRED"`	recipe/emailverification/types.ts
`override?`	`object`	recipe/emailverification/types.ts
`override.functions()?`	(`originalImplementation`, `builder`) => `SuperTokensWrapper`	recipe/emailverification/types.ts
`sendVerifyEmailScreen?`	`FeatureBaseConfig`	recipe/emailverification/types.ts
`verifyEmailLinkClickedScreen?`	`FeatureBaseConfig`	recipe/emailverification/types.ts

type VerifyEmailLinkClickedThemeProps = ThemeBaseProps & object;

Name	Type	Defined in
`config`	`NormalisedConfig`	recipe/emailverification/types.ts
`onSuccess()`	() => `Promise`<`void`>	recipe/emailverification/types.ts
`onTokenInvalidRedirect()`	() => `Promise`<`void`>	recipe/emailverification/types.ts
`recipeImplementation`	`SuperTokensWrapper`	recipe/emailverification/types.ts
`token`	`string`	recipe/emailverification/types.ts