useUser

Read the current Openfort player and refresh authentication tokens on demand.

Request

type Request = {
  hook: 'useUser',
  params: []
}

Response

type Response = UseUserResult
 
type UseUserResult = {
  user: import("@openfort/openfort-js").AuthPlayerResponse | null
  isAuthenticated: boolean
  getAccessToken(): Promise<string | null>
  validateAndRefreshToken(): Promise<void>
}

Example

import { useUser } from "@openfort/react"
 
function SampleComponent() {
  const {
    user,
    isAuthenticated,
    getAccessToken,
    validateAndRefreshToken,
  } = useUser()
 
  if (!isAuthenticated) return <SignIn />
 
  return (
    <ProfilePage
      name={user?.player.name}
      onRefreshToken={validateAndRefreshToken}
    />
  )
}