Search
Preparing search index...
The search index is not available
supertokens-website
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
supertokens-website
BooleanClaim
Class BooleanClaim
Hierarchy
PrimitiveClaim
<
boolean
>
BooleanClaim
Index
Constructors
constructor
Properties
default
Max
Age
In
Seconds
id
refresh
validators
Methods
get
Last
Fetched
Time
get
Value
From
Payload
Constructors
constructor
new
Boolean
Claim
(
config
:
PrimitiveClaimConfig
)
:
BooleanClaim
Parameters
config:
PrimitiveClaimConfig
Returns
BooleanClaim
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
:
{
hasValue
:
(
(
val
:
boolean
, maxAgeInSeconds
?:
undefined
|
number
, id
?:
string
)
=>
SessionClaimValidator
)
}
&
BooleanValidators
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
)
:
boolean
Parameters
payload:
any
Optional
_userContext:
any
Returns
boolean
Exports
Boolean
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.