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
default
Class default
Hierarchy
default
Index
Constructors
constructor
Properties
Error
init
Methods
create
Email
Verification
Token
is
Email
Verified
revoke
Email
Verification
Tokens
unverify
Email
verify
Email
Using
Token
Constructors
constructor
new default
(
)
:
default
Returns
default
Properties
Static
Error
Error
:
typeof
default
= ...
Static
init
init
:
(
config
:
TypeInput
)
=>
RecipeListFunction
= ...
Type declaration
(
config
:
TypeInput
)
:
RecipeListFunction
Parameters
config:
TypeInput
Returns
RecipeListFunction
Methods
Static
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"
}
>
Static
is
Email
Verified
is
Email
Verified
(
userId
:
string
, email
:
string
)
:
Promise
<
boolean
>
Parameters
userId:
string
email:
string
Returns
Promise
<
boolean
>
Static
revoke
Email
Verification
Tokens
revoke
Email
Verification
Tokens
(
userId
:
string
, email
:
string
)
:
Promise
<
{
status
:
"OK"
}
>
Parameters
userId:
string
email:
string
Returns
Promise
<
{
status
:
"OK"
}
>
Static
unverify
Email
unverify
Email
(
userId
:
string
, email
:
string
)
:
Promise
<
{
status
:
"OK"
}
>
Parameters
userId:
string
email:
string
Returns
Promise
<
{
status
:
"OK"
}
>
Static
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
constructor
Error
init
create
Email
Verification
Token
is
Email
Verified
revoke
Email
Verification
Tokens
unverify
Email
verify
Email
Using
Token
Generated using
TypeDoc