Search
Preparing search index...
The search index is not available
supertokens-node
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
supertokens-node
recipe/emailverification
Module recipe/emailverification
Index
Classes
default
Interfaces
APIInterface
Recipe
Interface
Type aliases
APIOptions
User
Variables
Error
Functions
create
Email
Verification
Token
init
is
Email
Verified
revoke
Email
Verification
Tokens
unverify
Email
verify
Email
Using
Token
Type aliases
APIOptions
APIOptions
:
{
config
:
TypeNormalisedInput
;
isInServerlessEnv
:
boolean
;
recipeId
:
string
;
recipeImplementation
:
RecipeInterface
;
req
:
BaseRequest
;
res
:
BaseResponse
}
Type declaration
config
:
TypeNormalisedInput
is
In
Serverless
Env
:
boolean
recipe
Id
:
string
recipe
Implementation
:
RecipeInterface
req
:
BaseRequest
res
:
BaseResponse
User
User
:
{
email
:
string
;
id
:
string
}
Type declaration
email
:
string
id
:
string
Variables
Error
Error
:
typeof
default
= ...
Functions
create
Email
Verification
Token
create
Email
Verification
Token
(
userId
:
string
, email
:
string
)
:
Promise
<
{
status
:
"OK"
;
token
:
string
}
|
{
status
:
"EMAIL_ALREADY_VERIFIED_ERROR"
}
>
Parameters
userId:
string
email:
string
Returns
Promise
<
{
status
:
"OK"
;
token
:
string
}
|
{
status
:
"EMAIL_ALREADY_VERIFIED_ERROR"
}
>
init
init
(
config
:
TypeInput
)
:
RecipeListFunction
Parameters
config:
TypeInput
Returns
RecipeListFunction
is
Email
Verified
is
Email
Verified
(
userId
:
string
, email
:
string
)
:
Promise
<
boolean
>
Parameters
userId:
string
email:
string
Returns
Promise
<
boolean
>
revoke
Email
Verification
Tokens
revoke
Email
Verification
Tokens
(
userId
:
string
, email
:
string
)
:
Promise
<
{
status
:
"OK"
}
>
Parameters
userId:
string
email:
string
Returns
Promise
<
{
status
:
"OK"
}
>
unverify
Email
unverify
Email
(
userId
:
string
, email
:
string
)
:
Promise
<
{
status
:
"OK"
}
>
Parameters
userId:
string
email:
string
Returns
Promise
<
{
status
:
"OK"
}
>
verify
Email
Using
Token
verify
Email
Using
Token
(
token
:
string
)
:
Promise
<
{
status
:
"OK"
;
user
:
User
}
|
{
status
:
"EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"
}
>
Parameters
token:
string
Returns
Promise
<
{
status
:
"OK"
;
user
:
User
}
|
{
status
:
"EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"
}
>
Modules
framework
framework/aws
Lambda
framework/express
framework/fastify
framework/hapi
framework/koa
framework/loopback
index
recipe/emailpassword
recipe/emailverification
recipe/jwt
recipe/session
recipe/thirdparty
recipe/thirdpartyemailpassword
default
APIInterface
Recipe
Interface
APIOptions
User
Error
create
Email
Verification
Token
init
is
Email
Verified
revoke
Email
Verification
Tokens
unverify
Email
verify
Email
Using
Token
Generated using
TypeDoc