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
|
GetRedirectionURLContext
,
Action
,
R
|
OnHandleEventContext
>
Hierarchy
default
<
T
|
GetRedirectionURLContext
,
Action
,
R
|
OnHandleEventContext
,
N
>
default
Index
Constructors
constructor
Properties
config
recipeID
Methods
does
Session
Exist
get
Auth
Recipe
Default
RedirectionURL
get
Default
RedirectionURL
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
<
GetRedirectionURLContext
|
T
,
Action
,
OnHandleEventContext
|
R
>
Parameters
config:
NormalisedConfigWithAppInfoAndRecipeID
<
N
>
Returns
default
<
T
,
Action
,
R
,
N
>
Properties
config
config
:
NormalisedConfigWithAppInfoAndRecipeID
<
N
>
Abstract
recipeID
recipeID
:
string
Methods
does
Session
Exist
does
Session
Exist
(
input
?:
{
userContext
?:
any
}
)
:
Promise
<
boolean
>
Parameters
Optional
input:
{
userContext
?:
any
}
Optional
user
Context
?:
any
Returns
Promise
<
boolean
>
get
Auth
Recipe
Default
RedirectionURL
get
Auth
Recipe
Default
RedirectionURL
(
context
:
GetRedirectionURLContext
)
:
Promise
<
string
>
Parameters
context:
GetRedirectionURLContext
Returns
Promise
<
string
>
get
Default
RedirectionURL
get
Default
RedirectionURL
(
_
:
GetRedirectionURLContext
|
T
)
:
Promise
<
string
>
Parameters
_:
GetRedirectionURLContext
|
T
Returns
Promise
<
string
>
get
Redirect
Url
get
Redirect
Url
(
context
:
GetRedirectionURLContextType
)
:
Promise
<
string
>
Parameters
context:
GetRedirectionURLContextType
Returns
Promise
<
string
>
redirect
redirect
(
context
:
GetRedirectionURLContextType
, history
?:
any
, queryParams
?:
Record
<
string
,
string
>
)
:
Promise
<
void
>
Parameters
context:
GetRedirectionURLContextType
Optional
history:
any
Optional
queryParams:
Record
<
string
,
string
>
Returns
Promise
<
void
>
sign
Out
sign
Out
(
input
?:
{
userContext
?:
any
}
)
:
Promise
<
void
>
Parameters
Optional
input:
{
userContext
?:
any
}
Optional
user
Context
?:
any
Returns
Promise
<
void
>
Modules
index
recipe/auth
Recipe
recipe/emailpassword
recipe/emailverification
recipe/multitenancy
recipe/passwordless
recipe/recipe
Module
recipe/session
recipe/thirdparty
recipe/thirdpartyemailpassword
recipe/thirdpartypasswordless
recipe/userroles
default
constructor
config
recipeID
does
Session
Exist
get
Auth
Recipe
Default
RedirectionURL
get
Default
RedirectionURL
get
Redirect
Url
redirect
sign
Out
Generated using
TypeDoc