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/authRecipe
default
Class default<T, Action, R, N>
Abstract
Type Parameters
T
Action
R
N
extends
NormalisedConfig
<
T
,
Action
,
R
|
OnHandleEventContext
>
Hierarchy
default
<
T
,
Action
,
R
|
OnHandleEventContext
,
N
>
default
Index
Constructors
constructor
Properties
config
first
Factor
Ids
recipeID
Methods
does
Session
Exist
get
Auth
Recipe
Default
RedirectionURL
get
Default
RedirectionURL
get
First
Factors
For
Auth
Page
get
Redirect
Url
redirect
sign
Out
Constructors
constructor
new default
<
T
,
Action
,
R
,
N
>
(
config
:
NormalisedConfigWithAppInfoAndRecipeID
<
N
>
)
:
default
<
T
,
Action
,
R
,
N
>
Type Parameters
T
Action
R
N
extends
NormalisedConfig
<
T
,
Action
,
R
>
Parameters
config:
NormalisedConfigWithAppInfoAndRecipeID
<
N
>
Returns
default
<
T
,
Action
,
R
,
N
>
Properties
config
config
:
NormalisedConfigWithAppInfoAndRecipeID
<
N
>
Abstract
first
Factor
Ids
first
Factor
Ids
:
string
[]
Abstract
recipeID
recipeID
:
string
Methods
does
Session
Exist
does
Session
Exist
(
input
?:
{
userContext
?:
UserContext
}
)
:
Promise
<
boolean
>
Parameters
Optional
input:
{
userContext
?:
UserContext
}
Optional
user
Context
?:
UserContext
Returns
Promise
<
boolean
>
get
Auth
Recipe
Default
RedirectionURL
get
Auth
Recipe
Default
RedirectionURL
(
_context
:
T
)
:
Promise
<
string
>
Parameters
_context:
T
Returns
Promise
<
string
>
get
Default
RedirectionURL
get
Default
RedirectionURL
(
_
:
NormalisedGetRedirectionURLContext
<
T
>
, _userContext
:
UserContext
)
:
Promise
<
string
>
Parameters
_:
NormalisedGetRedirectionURLContext
<
T
>
_userContext:
UserContext
Returns
Promise
<
string
>
Abstract
get
First
Factors
For
Auth
Page
get
First
Factors
For
Auth
Page
(
)
:
string
[]
Returns
string
[]
get
Redirect
Url
get
Redirect
Url
(
context
:
NormalisedGetRedirectionURLContext
<
GetRedirectionURLContextType
>
, userContext
:
UserContext
)
:
Promise
<
null
|
string
>
Parameters
context:
NormalisedGetRedirectionURLContext
<
GetRedirectionURLContextType
>
userContext:
UserContext
Returns
Promise
<
null
|
string
>
redirect
redirect
(
context
:
NormalisedGetRedirectionURLContext
<
GetRedirectionURLContextType
>
, navigate
:
undefined
|
Navigate
, queryParams
?:
Record
<
string
,
string
>
, userContext
?:
UserContext
)
:
Promise
<
void
>
Parameters
context:
NormalisedGetRedirectionURLContext
<
GetRedirectionURLContextType
>
navigate:
undefined
|
Navigate
Optional
queryParams:
Record
<
string
,
string
>
Optional
userContext:
UserContext
Returns
Promise
<
void
>
sign
Out
sign
Out
(
input
?:
{
userContext
?:
UserContext
}
)
:
Promise
<
void
>
Parameters
Optional
input:
{
userContext
?:
UserContext
}
Optional
user
Context
?:
UserContext
Returns
Promise
<
void
>
Modules
date
Provider
index
recipe/auth
Recipe
recipe/emailpassword
recipe/emailverification
recipe/multifactorauth
recipe/multitenancy
recipe/oauth2provider
recipe/passwordless
recipe/recipe
Module
recipe/session
recipe/thirdparty
recipe/totp
recipe/userroles
default
constructor
config
first
Factor
Ids
recipeID
does
Session
Exist
get
Auth
Recipe
Default
RedirectionURL
get
Default
RedirectionURL
get
First
Factors
For
Auth
Page
get
Redirect
Url
redirect
sign
Out
Generated using
TypeDoc