Search
Preparing search index...
The search index is not available
supertokens-website
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
supertokens-website
default
Class default
Hierarchy
default
Index
Constructors
constructor
Properties
axios
Interceptor
Queue
get
Claim
Value
get
Invalid
Claims
From
Response
Methods
add
Axios
Interceptors
attempt
Refreshing
Session
does
Session
Exist
get
Access
Token
get
Access
Token
Payload
Securely
get
User
Id
init
sign
Out
validate
Claims
Constructors
constructor
new default
(
)
:
default
Returns
default
Properties
Static
Private
axios
Interceptor
Queue
axios
Interceptor
Queue
:
(
(
)
=>
void
)
[]
= []
Static
get
Claim
Value
get
Claim
Value
:
(
<
T
>
(
input
:
{
claim
:
SessionClaim
<
T
>
;
userContext
?:
any
}
)
=>
Promise
<
undefined
|
T
>
)
= ...
Type declaration
<
T
>
(
input
:
{
claim
:
SessionClaim
<
T
>
;
userContext
?:
any
}
)
:
Promise
<
undefined
|
T
>
Type Parameters
T
Parameters
input:
{
claim
:
SessionClaim
<
T
>
;
userContext
?:
any
}
claim
:
SessionClaim
<
T
>
Optional
user
Context
?:
any
Returns
Promise
<
undefined
|
T
>
Static
get
Invalid
Claims
From
Response
get
Invalid
Claims
From
Response
:
(
(
input
:
{
response
:
Response
|
{
data
:
any
}
;
userContext
?:
any
}
)
=>
Promise
<
ClaimValidationError
[]
>
)
= ...
Type declaration
(
input
:
{
response
:
Response
|
{
data
:
any
}
;
userContext
?:
any
}
)
:
Promise
<
ClaimValidationError
[]
>
Parameters
input:
{
response
:
Response
|
{
data
:
any
}
;
userContext
?:
any
}
response
:
Response
|
{
data
:
any
}
Optional
user
Context
?:
any
Returns
Promise
<
ClaimValidationError
[]
>
Methods
Static
add
Axios
Interceptors
add
Axios
Interceptors
(
axiosInstance
:
any
, userContext
?:
any
)
:
void
deprecated
Parameters
axiosInstance:
any
Optional
userContext:
any
Returns
void
Static
attempt
Refreshing
Session
attempt
Refreshing
Session
(
)
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
Static
does
Session
Exist
does
Session
Exist
(
input
?:
{
userContext
?:
any
}
)
:
Promise
<
boolean
>
Parameters
Optional
input:
{
userContext
?:
any
}
Optional
user
Context
?:
any
Returns
Promise
<
boolean
>
Static
get
Access
Token
get
Access
Token
(
input
?:
{
userContext
?:
any
}
)
:
Promise
<
undefined
|
string
>
Parameters
Optional
input:
{
userContext
?:
any
}
Optional
user
Context
?:
any
Returns
Promise
<
undefined
|
string
>
Static
get
Access
Token
Payload
Securely
get
Access
Token
Payload
Securely
(
input
?:
{
userContext
?:
any
}
)
:
Promise
<
any
>
Parameters
Optional
input:
{
userContext
?:
any
}
Optional
user
Context
?:
any
Returns
Promise
<
any
>
Static
get
User
Id
get
User
Id
(
input
?:
{
userContext
?:
any
}
)
:
Promise
<
string
>
Parameters
Optional
input:
{
userContext
?:
any
}
Optional
user
Context
?:
any
Returns
Promise
<
string
>
Static
init
init
(
options
:
InputType
)
:
void
Parameters
options:
InputType
Returns
void
Static
sign
Out
sign
Out
(
input
?:
{
userContext
?:
any
}
)
:
Promise
<
void
>
Parameters
Optional
input:
{
userContext
?:
any
}
Optional
user
Context
?:
any
Returns
Promise
<
void
>
Static
validate
Claims
validate
Claims
(
overrideGlobalClaimValidators
?:
(
(
globalClaimValidators
:
SessionClaimValidator
[]
, userContext
:
any
)
=>
SessionClaimValidator
[]
)
, userContext
?:
any
)
:
ClaimValidationError
[]
|
Promise
<
ClaimValidationError
[]
>
Parameters
Optional
overrideGlobalClaimValidators:
(
(
globalClaimValidators
:
SessionClaimValidator
[]
, userContext
:
any
)
=>
SessionClaimValidator
[]
)
(
globalClaimValidators
:
SessionClaimValidator
[]
, userContext
:
any
)
:
SessionClaimValidator
[]
Parameters
globalClaimValidators:
SessionClaimValidator
[]
userContext:
any
Returns
SessionClaimValidator
[]
Optional
userContext:
any
Returns
ClaimValidationError
[]
|
Promise
<
ClaimValidationError
[]
>
Exports
default
constructor
axios
Interceptor
Queue
get
Claim
Value
get
Invalid
Claims
From
Response
add
Axios
Interceptors
attempt
Refreshing
Session
does
Session
Exist
get
Access
Token
get
Access
Token
Payload
Securely
get
User
Id
init
sign
Out
validate
Claims
Generated using
TypeDoc