_auth_.md

reactfire

Globals / "auth"

Module: "auth"

Index

Interfaces

• AuthCheckProps
• ClaimsCheckProps

Functions

• AuthCheck
• ClaimsCheck
• preloadUser
• useIdTokenResult
• useUser

Functions

AuthCheck

▸ AuthCheck(__namedParameters: { auth: undefined | Auth ; children: ReactNode ; fallback: ReactNode ; requiredClaims: undefined | Object }): Element

Defined in src/auth.tsx:97

Parameters:

Name	Type
__namedParameters	{ auth: undefined | Auth ; children: ReactNode ; fallback: ReactNode ; requiredClaims: undefined | Object }

Returns: Element

---

ClaimsCheck

▸ ClaimsCheck(__namedParameters: { children: ReactNode ; fallback: ReactNode ; requiredClaims: undefined | { [key:string]: any; } ; user: User }): Element

Defined in src/auth.tsx:74

Parameters:

Name	Type
__namedParameters	{ children: ReactNode ; fallback: ReactNode ; requiredClaims: undefined | { [key:string]: any; } ; user: User }

Returns: Element

---

preloadUser

▸ preloadUser(options?: undefined | { firebaseApp?: firebase.app.App }): Promise<User>

Defined in src/auth.tsx:8

Parameters:

Name	Type
options?	undefined | { firebaseApp?: firebase.app.App }

Returns: Promise<User>

---

useIdTokenResult

▸ useIdTokenResult(user: User, forceRefresh?: boolean, options?: ReactFireOptions<IdTokenResult>): ObservableStatus<IdTokenResult>

Defined in src/auth.tsx:45

Parameters:

Name	Type	Default value
user	User	-
forceRefresh	boolean	false
options?	ReactFireOptions<IdTokenResult>	-

Returns: ObservableStatus<IdTokenResult>

---

useUser

▸ useUser<T>(auth?: firebase.auth.Auth, options?: ReactFireOptions<T>): ObservableStatus<User>

Defined in src/auth.tsx:24

Subscribe to Firebase auth state changes, including token refresh

Type parameters:

Name	Default
T	unknown

Parameters:

Name	Type	Description
auth?	firebase.auth.Auth	the firebase.auth object
options?	ReactFireOptions<T>

Returns: ObservableStatus<User>