Search
Preparing search index...
The search index is not available
supertokens-website
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
supertokens-website
PrimitiveArrayClaim
Class PrimitiveArrayClaim<ValueType>
Type Parameters
ValueType
Hierarchy
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
<
ValueType
>
(
config
:
PrimitiveArrayClaimConfig
)
:
PrimitiveArrayClaim
<
ValueType
>
Type Parameters
ValueType
Parameters
config:
PrimitiveArrayClaimConfig
Returns
PrimitiveArrayClaim
<
ValueType
>
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
:
(
(
val
:
ValueType
, maxAgeInSeconds
?:
undefined
|
number
, id
?:
string
)
=>
SessionClaimValidator
)
;
excludesAll
:
(
(
val
:
ValueType
[]
, maxAgeInSeconds
?:
undefined
|
number
, id
?:
string
)
=>
SessionClaimValidator
)
;
includes
:
(
(
val
:
ValueType
, maxAgeInSeconds
?:
undefined
|
number
, id
?:
string
)
=>
SessionClaimValidator
)
;
includesAll
:
(
(
val
:
ValueType
[]
, maxAgeInSeconds
?:
undefined
|
number
, id
?:
string
)
=>
SessionClaimValidator
)
;
includesAny
:
(
(
val
:
ValueType
[]
, maxAgeInSeconds
?:
undefined
|
number
, id
?:
string
)
=>
SessionClaimValidator
)
}
= ...
Type declaration
excludes
:
(
(
val
:
ValueType
, maxAgeInSeconds
?:
undefined
|
number
, id
?:
string
)
=>
SessionClaimValidator
)
(
val
:
ValueType
, maxAgeInSeconds
?:
undefined
|
number
, id
?:
string
)
:
SessionClaimValidator
Parameters
val:
ValueType
maxAgeInSeconds:
undefined
|
number
= ...
Optional
id:
string
Returns
SessionClaimValidator
excludes
All
:
(
(
val
:
ValueType
[]
, maxAgeInSeconds
?:
undefined
|
number
, id
?:
string
)
=>
SessionClaimValidator
)
(
val
:
ValueType
[]
, maxAgeInSeconds
?:
undefined
|
number
, id
?:
string
)
:
SessionClaimValidator
Parameters
val:
ValueType
[]
maxAgeInSeconds:
undefined
|
number
= ...
Optional
id:
string
Returns
SessionClaimValidator
includes
:
(
(
val
:
ValueType
, maxAgeInSeconds
?:
undefined
|
number
, id
?:
string
)
=>
SessionClaimValidator
)
(
val
:
ValueType
, maxAgeInSeconds
?:
undefined
|
number
, id
?:
string
)
:
SessionClaimValidator
Parameters
val:
ValueType
maxAgeInSeconds:
undefined
|
number
= ...
Optional
id:
string
Returns
SessionClaimValidator
includes
All
:
(
(
val
:
ValueType
[]
, maxAgeInSeconds
?:
undefined
|
number
, id
?:
string
)
=>
SessionClaimValidator
)
(
val
:
ValueType
[]
, maxAgeInSeconds
?:
undefined
|
number
, id
?:
string
)
:
SessionClaimValidator
Parameters
val:
ValueType
[]
maxAgeInSeconds:
undefined
|
number
= ...
Optional
id:
string
Returns
SessionClaimValidator
includes
Any
:
(
(
val
:
ValueType
[]
, maxAgeInSeconds
?:
undefined
|
number
, id
?:
string
)
=>
SessionClaimValidator
)
(
val
:
ValueType
[]
, maxAgeInSeconds
?:
undefined
|
number
, id
?:
string
)
:
SessionClaimValidator
Parameters
val:
ValueType
[]
maxAgeInSeconds:
undefined
|
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
)
:
ValueType
[]
Parameters
payload:
any
Optional
_userContext:
any
Returns
ValueType
[]
Exports
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.