Search
Preparing search index...
The search index is not available
supertokens-auth-react
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
supertokens-auth-react
recipe/authRecipeModule
default
Class default<T, S, R, N>
Type parameters
T
S
R
N
:
NormalisedConfig
<
T
|
GetRedirectionURLContext
,
S
|
PreAPIHookContext
,
R
|
OnHandleEventContext
>
Hierarchy
default
<
T
|
GetRedirectionURLContext
,
S
|
PreAPIHookContext
,
R
|
OnHandleEventContext
,
N
>
default
Index
Constructors
constructor
Properties
config
email
Verification
Methods
does
Session
Exist
get
Auth
Recipe
Module
Default
RedirectionURL
get
Auth
Recipe
Module
Feature
Component
get
Auth
Recipe
Module
Features
get
Default
RedirectionURL
get
Feature
Component
get
Features
get
Redirect
Url
redirect
redirect
To
Auth
With
Redirect
To
Path
redirect
To
Auth
Without
Redirect
To
Path
save
Post
Email
Verification
Success
Redirect
State
sign
Out
Constructors
constructor
new default
<
T
,
S
,
R
,
N
>
(
config
:
N
, recipes
:
{
emailVerificationInstance
:
undefined
|
default
}
)
:
default
<
T
,
S
,
R
,
N
>
Type parameters
T
S
R
N
:
NormalisedConfig
<
T
|
{
action
:
"SUCCESS"
;
isNewUser
:
boolean
;
redirectToPath
?:
string
}
|
{
action
:
"SIGN_IN_AND_UP"
}
|
GetRedirectionURLContext
,
S
|
PreAPIHookContext
,
R
|
{
action
:
"SESSION_ALREADY_EXISTS"
}
|
{
action
:
"SUCCESS"
;
isNewUser
:
boolean
;
user
:
{
email
:
string
;
id
:
string
}
}
|
OnHandleEventContext
>
Parameters
config:
N
recipes:
{
emailVerificationInstance
:
undefined
|
default
}
email
Verification
Instance
:
undefined
|
default
Returns
default
<
T
,
S
,
R
,
N
>
Properties
config
config
:
N
email
Verification
email
Verification
:
default
Methods
does
Session
Exist
does
Session
Exist
(
)
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
get
Auth
Recipe
Module
Default
RedirectionURL
get
Auth
Recipe
Module
Default
RedirectionURL
(
context
:
GetRedirectionURLContext
)
:
Promise
<
string
>
Parameters
context:
GetRedirectionURLContext
Returns
Promise
<
string
>
get
Auth
Recipe
Module
Feature
Component
get
Auth
Recipe
Module
Feature
Component
(
componentName
:
"emailverification"
, props
:
any
)
:
Element
Parameters
componentName:
"emailverification"
props:
any
Returns
Element
get
Auth
Recipe
Module
Features
get
Auth
Recipe
Module
Features
(
)
:
Record
<
string
,
ComponentWithRecipeAndMatchingMethod
>
Returns
Record
<
string
,
ComponentWithRecipeAndMatchingMethod
>
get
Default
RedirectionURL
get
Default
RedirectionURL
(
_
:
T
|
{
action
:
"SUCCESS"
;
isNewUser
:
boolean
;
redirectToPath
?:
string
}
|
{
action
:
"SIGN_IN_AND_UP"
}
|
GetRedirectionURLContext
)
:
Promise
<
string
>
Parameters
_:
T
|
{
action
:
"SUCCESS"
;
isNewUser
:
boolean
;
redirectToPath
?:
string
}
|
{
action
:
"SIGN_IN_AND_UP"
}
|
GetRedirectionURLContext
Returns
Promise
<
string
>
Abstract
get
Feature
Component
get
Feature
Component
(
componentName
:
string
, props
:
any
)
:
Element
Parameters
componentName:
string
props:
any
Returns
Element
Abstract
get
Features
get
Features
(
)
:
Record
<
string
,
ComponentWithRecipeAndMatchingMethod
>
Returns
Record
<
string
,
ComponentWithRecipeAndMatchingMethod
>
get
Redirect
Url
get
Redirect
Url
(
context
:
T
)
:
Promise
<
string
>
Parameters
context:
T
Returns
Promise
<
string
>
redirect
redirect
(
context
:
T
, history
?:
any
, queryParams
?:
Record
<
string
,
string
>
)
:
Promise
<
void
>
Parameters
context:
T
Optional
history:
any
Optional
queryParams:
Record
<
string
,
string
>
Returns
Promise
<
void
>
redirect
To
Auth
With
Redirect
To
Path
redirect
To
Auth
With
Redirect
To
Path
(
show
?:
"signin"
|
"signup"
, history
?:
any
, queryParams
?:
any
)
:
void
Parameters
Optional
show:
"signin"
|
"signup"
Optional
history:
any
Optional
queryParams:
any
Returns
void
redirect
To
Auth
Without
Redirect
To
Path
redirect
To
Auth
Without
Redirect
To
Path
(
show
?:
"signin"
|
"signup"
, history
?:
any
, queryParams
?:
any
)
:
void
Parameters
Optional
show:
"signin"
|
"signup"
Optional
history:
any
Optional
queryParams:
any
Returns
void
save
Post
Email
Verification
Success
Redirect
State
save
Post
Email
Verification
Success
Redirect
State
(
context
:
T
)
:
Promise
<
void
>
Parameters
context:
T
Returns
Promise
<
void
>
sign
Out
sign
Out
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
Modules
index
recipe/auth
Recipe
Module
recipe/emailpassword
recipe/recipe
Module
recipe/session
recipe/thirdparty
recipe/thirdpartyemailpassword
default
constructor
config
email
Verification
does
Session
Exist
get
Auth
Recipe
Module
Default
RedirectionURL
get
Auth
Recipe
Module
Feature
Component
get
Auth
Recipe
Module
Features
get
Default
RedirectionURL
get
Feature
Component
get
Features
get
Redirect
Url
redirect
redirect
To
Auth
With
Redirect
To
Path
redirect
To
Auth
Without
Redirect
To
Path
save
Post
Email
Verification
Success
Redirect
State
sign
Out
Generated using
TypeDoc