@authgear/nextjs / client / UseAuthgearReturn
Interface: UseAuthgearReturn
Defined in: src/hooks/useAuthgear.ts:6
Properties
isAuthenticated
isAuthenticated:
boolean
Defined in: src/hooks/useAuthgear.ts:14
Whether the user is currently authenticated
isLoaded
isLoaded:
boolean
Defined in: src/hooks/useAuthgear.ts:12
Whether the initial session check has completed
openPage()
openPage: (
path) =>void
Defined in: src/hooks/useAuthgear.ts:20
Open an Authgear page (e.g. Page.Settings) in a new tab
Parameters
path
string
Returns
void
signIn()
signIn: (
options?) =>void
Defined in: src/hooks/useAuthgear.ts:16
Navigate to the sign-in page
Parameters
options?
Returns
void
signOut()
signOut: () =>
void
Defined in: src/hooks/useAuthgear.ts:18
Navigate to the sign-out endpoint
Returns
void
state
state:
SessionState
Defined in: src/hooks/useAuthgear.ts:8
Current session state
user
user:
UserInfo|null
Defined in: src/hooks/useAuthgear.ts:10
Current user info, null if not authenticated