EmailVerification

Classes

default

Defined in: recipe/emailverification/index.ts:31

Constructors

Constructor

new default(): default;

Returns

default

Properties

Property	Modifier	Type	Default value	Defined in
ComponentsOverrideProvider	static	any	RecipeComponentsOverrideContextProvider	recipe/emailverification/index.ts:79
EmailVerificationClaim	static	any	EmailVerificationRecipe.EmailVerificationClaim	recipe/emailverification/index.ts:32

Methods

getEmailVerificationTokenFromURL()

static getEmailVerificationTokenFromURL(input?): string;

Defined in: recipe/emailverification/index.ts:72

Parameters

Parameter	Type
input?	{ userContext?: UserContext; }
input.userContext?	UserContext

Returns

string

init()

static init(config?): any;

Defined in: recipe/emailverification/index.ts:34

Parameters

Parameter	Type
config?	UserInput

Returns

any

isEmailVerified()

static isEmailVerified(input?): Promise<{
  fetchResponse: Response;
  isVerified: boolean;
  status: "OK";
}>;

Defined in: recipe/emailverification/index.ts:38

Parameters

Parameter	Type
input?	{ options?: RecipeFunctionOptions; userContext?: UserContext; }
input.options?	RecipeFunctionOptions
input.userContext?	UserContext

Returns

Promise<{ fetchResponse: Response; isVerified: boolean; status: "OK"; }>

sendVerificationEmail()

static sendVerificationEmail(input?): Promise<{
  fetchResponse: Response;
  status: "OK" | "EMAIL_ALREADY_VERIFIED_ERROR";
}>;

Defined in: recipe/emailverification/index.ts:59

Parameters

Parameter	Type
input?	{ options?: RecipeFunctionOptions; userContext?: UserContext; }
input.options?	RecipeFunctionOptions
input.userContext?	UserContext

Returns

Promise<{ fetchResponse: Response; status: "OK" | "EMAIL_ALREADY_VERIFIED_ERROR"; }>

verifyEmail()

static verifyEmail(input?): Promise<{
  fetchResponse: Response;
  status: "OK" | "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR";
}>;

Defined in: recipe/emailverification/index.ts:49

Parameters

Parameter	Type
input?	{ options?: RecipeFunctionOptions; userContext?: UserContext; }
input.options?	RecipeFunctionOptions
input.userContext?	UserContext

Returns

Promise<{ fetchResponse: Response; status: "OK" | "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"; }>

Variables

EmailVerificationClaim

const EmailVerificationClaim: any = EmailVerificationRecipe.EmailVerificationClaim;

Defined in: recipe/emailverification/index.ts:88

EmailVerificationComponentsOverrideProvider

const EmailVerificationComponentsOverrideProvider: any = Wrapper.ComponentsOverrideProvider;

Defined in: recipe/emailverification/index.ts:87

getEmailVerificationTokenFromURL()

const getEmailVerificationTokenFromURL: (input?) => string = Wrapper.getEmailVerificationTokenFromURL;

Defined in: recipe/emailverification/index.ts:86

Parameters

Parameter	Type
input?	{ userContext?: UserContext; }
input.userContext?	UserContext

Returns

string

init()

const init: (config?) => any = Wrapper.init;

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

Parameters

Parameter	Type
config?	UserInput

Returns

any

isEmailVerified()

const isEmailVerified: (input?) => Promise<{
  fetchResponse: Response;
  isVerified: boolean;
  status: "OK";
}> = Wrapper.isEmailVerified;

Defined in: recipe/emailverification/index.ts:83

Parameters

Parameter	Type
input?	{ options?: RecipeFunctionOptions; userContext?: UserContext; }
input.options?	RecipeFunctionOptions
input.userContext?	UserContext

Returns

Promise<{ fetchResponse: Response; isVerified: boolean; status: "OK"; }>

sendVerificationEmail()

const sendVerificationEmail: (input?) => Promise<{
  fetchResponse: Response;
  status: "OK" | "EMAIL_ALREADY_VERIFIED_ERROR";
}> = Wrapper.sendVerificationEmail;

Defined in: recipe/emailverification/index.ts:85

Parameters

Parameter	Type
input?	{ options?: RecipeFunctionOptions; userContext?: UserContext; }
input.options?	RecipeFunctionOptions
input.userContext?	UserContext

Returns

Promise<{ fetchResponse: Response; status: "OK" | "EMAIL_ALREADY_VERIFIED_ERROR"; }>

verifyEmail()

const verifyEmail: (input?) => Promise<{
  fetchResponse: Response;
  status: "OK" | "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR";
}> = Wrapper.verifyEmail;

Defined in: recipe/emailverification/index.ts:84

Parameters

Parameter	Type
input?	{ options?: RecipeFunctionOptions; userContext?: UserContext; }
input.options?	RecipeFunctionOptions
input.userContext?	UserContext

Returns

Promise<{ fetchResponse: Response; status: "OK" | "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"; }>

References

GetRedirectionURLContext

Re-exports GetRedirectionURLContext

OnHandleEventContext

Re-exports OnHandleEventContext

PreAPIHookContext

Re-exports PreAPIHookContext

RecipeInterface

Renames and re-exports SuperTokensWrapper

UserInput

Re-exports UserInput