supertokens-node/recipe/emailverification/types

References documentation for the supertokens-node/recipe/emailverification/types package

Type Aliases

APIInterface

type APIInterface = object;

Defined in: recipe/emailverification/types.ts

Properties

Property	Type	Defined in
`generateEmailVerifyTokenPOST`	\| `undefined` \| (`input`) => `Promise`< \| { `status`: `"OK"`; } \| { `newSession?`: `SessionContainerInterface`; `status`: `"EMAIL_ALREADY_VERIFIED_ERROR"`; } \| `GeneralErrorResponse`>	recipe/emailverification/types.ts
`isEmailVerifiedGET`	\| `undefined` \| (`input`) => `Promise`< \| { `isVerified`: `boolean`; `newSession?`: `SessionContainerInterface`; `status`: `"OK"`; } \| `GeneralErrorResponse`>	recipe/emailverification/types.ts
`verifyEmailPOST`	\| `undefined` \| (`input`) => `Promise`< \| { `newSession?`: `SessionContainerInterface`; `status`: `"OK"`; `user`: `UserEmailInfo`; } \| { `status`: `"EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"`; } \| `GeneralErrorResponse`>	recipe/emailverification/types.ts

APIOptions

type APIOptions = object;

Defined in: recipe/emailverification/types.ts

Properties

Property	Type	Defined in
`appInfo`	`NormalisedAppinfo`	recipe/emailverification/types.ts
`config`	`TypeNormalisedInput`	recipe/emailverification/types.ts
`emailDelivery`	`EmailDeliveryIngredient`<`TypeEmailVerificationEmailDeliveryInput`>	recipe/emailverification/types.ts
`isInServerlessEnv`	`boolean`	recipe/emailverification/types.ts
`recipeId`	`string`	recipe/emailverification/types.ts
`recipeImplementation`	`RecipeInterface`	recipe/emailverification/types.ts
`req`	`BaseRequest`	recipe/emailverification/types.ts
`res`	`BaseResponse`	recipe/emailverification/types.ts

GetEmailForRecipeUserIdFunc()

type GetEmailForRecipeUserIdFunc = (user, recipeUserId, userContext) => Promise<
  | {
  email: string;
  status: "OK";
}
  | {
  status: "EMAIL_DOES_NOT_EXIST_ERROR" | "UNKNOWN_USER_ID_ERROR";
}>;

Defined in: recipe/emailverification/types.ts

Parameters

Parameter	Type
`user`	`User` \| `undefined`
`recipeUserId`	`RecipeUserId`
`userContext`	`UserContext`

Returns

Promise< | { email: string; status: "OK"; } | { status: "EMAIL_DOES_NOT_EXIST_ERROR" | "UNKNOWN_USER_ID_ERROR"; }>

RecipeInterface

type RecipeInterface = object;

Defined in: recipe/emailverification/types.ts

Methods

createEmailVerificationToken()

createEmailVerificationToken(input): Promise<
  | {
  status: "OK";
  token: string;
}
  | {
  status: "EMAIL_ALREADY_VERIFIED_ERROR";
}>;

Defined in: recipe/emailverification/types.ts

Parameters

Parameter	Type
`input`	{ `email`: `string`; `recipeUserId`: `RecipeUserId`; `tenantId`: `string`; `userContext`: `UserContext`; }
`input.email`	`string`
`input.recipeUserId`	`RecipeUserId`
`input.tenantId`	`string`
`input.userContext`	`UserContext`

Returns

Promise< | { status: "OK"; token: string; } | { status: "EMAIL_ALREADY_VERIFIED_ERROR"; }>

isEmailVerified()

isEmailVerified(input): Promise<boolean>;

Defined in: recipe/emailverification/types.ts

Parameters

Parameter	Type
`input`	{ `email`: `string`; `recipeUserId`: `RecipeUserId`; `userContext`: `UserContext`; }
`input.email`	`string`
`input.recipeUserId`	`RecipeUserId`
`input.userContext`	`UserContext`

Returns

Promise<boolean>

revokeEmailVerificationTokens()

revokeEmailVerificationTokens(input): Promise<{
  status: "OK";
}>;

Defined in: recipe/emailverification/types.ts

Parameters

Parameter	Type
`input`	{ `email`: `string`; `recipeUserId`: `RecipeUserId`; `tenantId`: `string`; `userContext`: `UserContext`; }
`input.email`	`string`
`input.recipeUserId`	`RecipeUserId`
`input.tenantId`	`string`
`input.userContext`	`UserContext`

Returns

Promise<{ status: "OK"; }>

unverifyEmail()

unverifyEmail(input): Promise<{
  status: "OK";
}>;

Defined in: recipe/emailverification/types.ts

Parameters

Parameter	Type
`input`	{ `email`: `string`; `recipeUserId`: `RecipeUserId`; `userContext`: `UserContext`; }
`input.email`	`string`
`input.recipeUserId`	`RecipeUserId`
`input.userContext`	`UserContext`

Returns

Promise<{ status: "OK"; }>

verifyEmailUsingToken()

verifyEmailUsingToken(input): Promise<
  | {
  status: "OK";
  user: UserEmailInfo;
}
  | {
  status: "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR";
}>;

Defined in: recipe/emailverification/types.ts

Parameters

Parameter	Type
`input`	{ `attemptAccountLinking`: `boolean`; `tenantId`: `string`; `token`: `string`; `userContext`: `UserContext`; }
`input.attemptAccountLinking`	`boolean`
`input.tenantId`	`string`
`input.token`	`string`
`input.userContext`	`UserContext`

Returns

Promise< | { status: "OK"; user: UserEmailInfo; } | { status: "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"; }>

TypeEmailVerificationEmailDeliveryInput

type TypeEmailVerificationEmailDeliveryInput = object;

Defined in: recipe/emailverification/types.ts

Properties

Property	Type	Defined in
`emailVerifyLink`	`string`	recipe/emailverification/types.ts
`tenantId`	`string`	recipe/emailverification/types.ts
`type`	`"EMAIL_VERIFICATION"`	recipe/emailverification/types.ts
`user`	`object`	recipe/emailverification/types.ts
`user.email`	`string`	recipe/emailverification/types.ts
`user.id`	`string`	recipe/emailverification/types.ts
`user.recipeUserId`	`RecipeUserId`	recipe/emailverification/types.ts

TypeInput

type TypeInput = object;

Defined in: recipe/emailverification/types.ts

Properties

Property	Type	Defined in
`emailDelivery?`	`EmailDeliveryTypeInput`<`TypeEmailVerificationEmailDeliveryInput`>	recipe/emailverification/types.ts
`getEmailForRecipeUserId?`	(`recipeUserId`, `userContext`) => `Promise`< \| { `email`: `string`; `status`: `"OK"`; } \| { `status`: `"EMAIL_DOES_NOT_EXIST_ERROR"` \| `"UNKNOWN_USER_ID_ERROR"`; }>	recipe/emailverification/types.ts
`mode`	`"REQUIRED"` \| `"OPTIONAL"`	recipe/emailverification/types.ts
`override?`	`object`	recipe/emailverification/types.ts
`override.apis?`	(`originalImplementation`, `builder`) => `APIInterface`	recipe/emailverification/types.ts
`override.functions?`	(`originalImplementation`, `builder`) => `RecipeInterface`	recipe/emailverification/types.ts

TypeNormalisedInput

type TypeNormalisedInput = object;

Defined in: recipe/emailverification/types.ts

Properties

Property	Type	Defined in
`getEmailDeliveryConfig`	(`isInServerlessEnv`) => `EmailDeliveryTypeInputWithService`<`TypeEmailVerificationEmailDeliveryInput`>	recipe/emailverification/types.ts
`getEmailForRecipeUserId?`	(`recipeUserId`, `userContext`) => `Promise`< \| { `email`: `string`; `status`: `"OK"`; } \| { `status`: `"EMAIL_DOES_NOT_EXIST_ERROR"` \| `"UNKNOWN_USER_ID_ERROR"`; }>	recipe/emailverification/types.ts
`mode`	`"REQUIRED"` \| `"OPTIONAL"`	recipe/emailverification/types.ts
`override`	`object`	recipe/emailverification/types.ts
`override.apis`	(`originalImplementation`, `builder`) => `APIInterface`	recipe/emailverification/types.ts
`override.functions`	(`originalImplementation`, `builder`) => `RecipeInterface`	recipe/emailverification/types.ts

UserEmailInfo

type UserEmailInfo = object;

Defined in: recipe/emailverification/types.ts

Properties

Property	Type	Defined in
`email`	`string`	recipe/emailverification/types.ts
`recipeUserId`	`RecipeUserId`	recipe/emailverification/types.ts