UseSessionResult
Defined in: packages/react/src/hooks/useSession.ts:55
Properties
Section titled “Properties”isExpired
Section titled “isExpired”isExpired:
boolean
Defined in: packages/react/src/hooks/useSession.ts:63
Whether session has expired
isExpiringSoon
Section titled “isExpiringSoon”isExpiringSoon:
boolean
Defined in: packages/react/src/hooks/useSession.ts:61
Whether session is expiring soon
isValid
Section titled “isValid”isValid:
boolean
Defined in: packages/react/src/hooks/useSession.ts:59
Whether session is valid and not expiring soon
jwtPayload
Section titled “jwtPayload”jwtPayload:
JwtPayload|null
Defined in: packages/react/src/hooks/useSession.ts:69
Parsed JWT payload (if available)
reauthenticate()
Section titled “reauthenticate()”reauthenticate: () =>
Promise<void>
Defined in: packages/react/src/hooks/useSession.ts:71
Trigger re-authentication (calls reconnect)
Returns
Section titled “Returns”Promise<void>
sessionState
Section titled “sessionState”sessionState:
SessionState
Defined in: packages/react/src/hooks/useSession.ts:57
Current session state
timeRemaining
Section titled “timeRemaining”timeRemaining:
number|undefined
Defined in: packages/react/src/hooks/useSession.ts:65
Time remaining in milliseconds (undefined if no session or expired)
timeRemainingFormatted
Section titled “timeRemainingFormatted”timeRemainingFormatted:
string
Defined in: packages/react/src/hooks/useSession.ts:67
Time remaining as formatted string (e.g., “4m 30s”)