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/session
PrimitiveArrayClaim
Class PrimitiveArrayClaim<T>
Type Parameters
T
Hierarchy
PrimitiveArrayClaim
<
T
>
PrimitiveArrayClaim
Index
Constructors
constructor
Properties
default
Max
Age
In
Seconds
id
refresh
validators
Methods
get
Last
Fetched
Time
get
Value
From
Payload
Constructors
constructor
new
Primitive
Array
Claim
<
T
>
(
config
:
PrimitiveArrayClaimConfig
&
{
onFailureRedirection
?:
ValidationFailureCallback
;
showAccessDeniedOnFailure
?:
boolean
}
)
:
PrimitiveArrayClaim
<
T
>
Type Parameters
T
Parameters
config:
PrimitiveArrayClaimConfig
&
{
onFailureRedirection
?:
ValidationFailureCallback
;
showAccessDeniedOnFailure
?:
boolean
}
Returns
PrimitiveArrayClaim
<
T
>
Properties
Readonly
default
Max
Age
In
Seconds
default
Max
Age
In
Seconds
:
undefined
|
number
Readonly
id
id
:
string
Readonly
refresh
refresh
:
(
(
userContext
:
any
)
=>
Promise
<
void
>
)
Type declaration
(
userContext
:
any
)
:
Promise
<
void
>
Makes an API call that will refresh the claim in the token.
Parameters
userContext:
any
Returns
Promise
<
void
>
validators
validators
:
{
excludes
:
any
;
excludesAll
:
any
;
includes
:
any
;
includesAll
:
any
;
includesAny
:
any
}
Type declaration
excludes
:
function
excludes
(
val
:
ValueType
, maxAgeInSeconds
?:
number
, id
?:
string
)
:
SessionClaimValidator
Parameters
val:
ValueType
Optional
maxAgeInSeconds:
number
Optional
id:
string
Returns
SessionClaimValidator
excludes
All
:
function
excludes
All
(
val
:
ValueType
[]
, maxAgeInSeconds
?:
number
, id
?:
string
)
:
SessionClaimValidator
Parameters
val:
ValueType
[]
Optional
maxAgeInSeconds:
number
Optional
id:
string
Returns
SessionClaimValidator
includes
:
function
includes
(
val
:
ValueType
, maxAgeInSeconds
?:
number
, id
?:
string
)
:
SessionClaimValidator
Parameters
val:
ValueType
Optional
maxAgeInSeconds:
number
Optional
id:
string
Returns
SessionClaimValidator
includes
All
:
function
includes
All
(
val
:
ValueType
[]
, maxAgeInSeconds
?:
number
, id
?:
string
)
:
SessionClaimValidator
Parameters
val:
ValueType
[]
Optional
maxAgeInSeconds:
number
Optional
id:
string
Returns
SessionClaimValidator
includes
Any
:
function
includes
Any
(
val
:
ValueType
[]
, maxAgeInSeconds
?:
number
, id
?:
string
)
:
SessionClaimValidator
Parameters
val:
ValueType
[]
Optional
maxAgeInSeconds:
number
Optional
id:
string
Returns
SessionClaimValidator
Methods
get
Last
Fetched
Time
get
Last
Fetched
Time
(
payload
:
any
, _userContext
?:
any
)
:
undefined
|
number
Parameters
payload:
any
Optional
_userContext:
any
Returns
undefined
|
number
get
Value
From
Payload
get
Value
From
Payload
(
payload
:
any
, _userContext
?:
any
)
:
T
[]
Parameters
payload:
any
Optional
_userContext:
any
Returns
T
[]
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
Primitive
Array
Claim
constructor
default
Max
Age
In
Seconds
id
refresh
validators
get
Last
Fetched
Time
get
Value
From
Payload
Generated using
TypeDoc
Makes an API call that will refresh the claim in the token.