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
default
Index
Constructors
constructor
Properties
config
Methods
does
Session
Exist
get
Auth
Recipe
Default
RedirectionURL
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
sign
Out
Constructors
constructor
new default
<
T
,
Action
,
R
,
N
>
(
config
:
N
)
:
default
<
T
,
Action
,
R
,
N
>
Type Parameters
T
Action
R
N
extends
NormalisedConfig
<
GetRedirectionURLContext
|
T
,
Action
,
OnHandleEventContext
|
R
>
Parameters
config:
N
Returns
default
<
T
,
Action
,
R
,
N
>
Properties
config
config
:
N
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
>
Abstract
get
Feature
Component
get
Feature
Component
(
componentName
:
string
, props
:
any
)
:
Element
Parameters
componentName:
string
props:
any
Returns
Element
Abstract
get
Features
get
Features
(
)
:
RecipeFeatureComponentMap
Returns
RecipeFeatureComponentMap
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
>
redirect
To
Auth
With
Redirect
To
Path
redirect
To
Auth
With
Redirect
To
Path
(
show
?:
"signin"
|
"signup"
, history
?:
any
, queryParams
?:
any
)
:
Promise
<
void
>
Parameters
Optional
show:
"signin"
|
"signup"
Optional
history:
any
Optional
queryParams:
any
Returns
Promise
<
void
>
redirect
To
Auth
Without
Redirect
To
Path
redirect
To
Auth
Without
Redirect
To
Path
(
show
?:
"signin"
|
"signup"
, history
?:
any
, queryParams
?:
any
)
:
Promise
<
void
>
Parameters
Optional
show:
"signin"
|
"signup"
Optional
history:
any
Optional
queryParams:
any
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/auth
Recipe
With
Email
Verification
recipe/emailpassword
recipe/passwordless
recipe/recipe
Module
recipe/session
recipe/thirdparty
recipe/thirdpartyemailpassword
recipe/thirdpartypasswordless
default
constructor
config
does
Session
Exist
get
Auth
Recipe
Default
RedirectionURL
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
sign
Out
Generated using
TypeDoc