UseAuthReturn
Defined in: react/src/hooks/createAuthHooks.ts:8
Properties
Section titled “Properties”authenticate
Section titled “authenticate”authenticate: () =>
Promise<Identity|undefined>
Defined in: react/src/hooks/createAuthHooks.ts:9
Returns
Section titled “Returns”Promise<Identity | undefined>
login: (
options?) =>Promise<void>
Defined in: react/src/hooks/createAuthHooks.ts:10
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<void>
logout
Section titled “logout”logout: (
options?) =>Promise<void>
Defined in: react/src/hooks/createAuthHooks.ts:11
Parameters
Section titled “Parameters”options?
Section titled “options?”returnTo?
Section titled “returnTo?”string
Returns
Section titled “Returns”Promise<void>
isAuthenticated
Section titled “isAuthenticated”isAuthenticated:
boolean
Defined in: react/src/hooks/createAuthHooks.ts:12
isAuthenticating
Section titled “isAuthenticating”isAuthenticating:
boolean
Defined in: react/src/hooks/createAuthHooks.ts:20
true while a sign-in or sign-out is in progress, and until the session
restore the first useAuth() starts has settled: on the first render, in
a server render and while the stored session is read. A restore that fails
settles it too. Show a loading state while it is true rather than
treating isAuthenticated: false as signed out.
principal
Section titled “principal”principal:
Principal|null
Defined in: react/src/hooks/createAuthHooks.ts:26
The signed-in user’s principal, or null while signed out. A signed-out
session still holds an anonymous identity, and its principal is not
returned here.
identity
Section titled “identity”identity:
Identity|null
Defined in: react/src/hooks/createAuthHooks.ts:27
error:
Error|undefined
Defined in: react/src/hooks/createAuthHooks.ts:28