supertokens-auth-react/recipe/emailverification

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

new default(): default;

Returns

default

Properties

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

Methods

getEmailVerificationTokenFromURL()

static getEmailVerificationTokenFromURL(input?): string;

Defined in: recipe/emailverification/index.ts

Parameters

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

Returns

string

init()

static init(config?): any;

Defined in: recipe/emailverification/index.ts

Parameters

Parameter	Type
`config?`	`UserInput`

Returns

any

isEmailVerified()

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

Defined in: recipe/emailverification/index.ts

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

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

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

EmailVerificationComponentsOverrideProvider

const EmailVerificationComponentsOverrideProvider: any = Wrapper.ComponentsOverrideProvider;

Defined in: recipe/emailverification/index.ts

getEmailVerificationTokenFromURL()

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

Defined in: recipe/emailverification/index.ts

Parameters

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

Returns

string

init()

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

Defined in: recipe/emailverification/index.ts

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

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

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

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

RecipeInterface

Renames and re-exports SuperTokensWrapper

UserInput

Re-exports UserInput