_index_.md

reactfire

Globals / "index"

Module: "index"

Index

References

• AuthCheck
• AuthCheckProps
• ClaimsCheck
• ClaimsCheckProps
• FirebaseAppProvider
• ObservableStatus
• PreloadOptions
• StorageImage
• SuspensePerfProps
• SuspenseWithPerf
• analytics
• auth
• database
• firestore
• functions
• messaging
• performance
• preloadAnalytics
• preloadAuth
• preloadDatabase
• preloadFirestore
• preloadFirestoreDoc
• preloadFunctions
• preloadMessaging
• preloadObservable
• preloadPerformance
• preloadRemoteConfig
• preloadStorage
• preloadUser
• remoteConfig
• storage
• useAnalytics
• useAuth
• useDatabase
• useDatabaseList
• useDatabaseListData
• useDatabaseObject
• useDatabaseObjectData
• useFirebaseApp
• useFirestore
• useFirestoreCollection
• useFirestoreCollectionData
• useFirestoreDoc
• useFirestoreDocData
• useFirestoreDocDataOnce
• useFirestoreDocOnce
• useFunctions
• useIdTokenResult
• useIsSuspenseEnabled
• useMessaging
• useObservable
• usePerformance
• useRemoteConfig
• useRemoteConfigAll
• useRemoteConfigBoolean
• useRemoteConfigNumber
• useRemoteConfigString
• useRemoteConfigValue
• useStorage
• useStorageDownloadURL
• useStorageTask
• useSuspenseEnabledFromConfigAndContext
• useUser
• version

Interfaces

• ReactFireOptions

Type aliases

• ReactFireGlobals

Functions

• checkIdField
• checkOptions
• checkinitialData

References

AuthCheck

Re-exports: AuthCheck

---

AuthCheckProps

Re-exports: AuthCheckProps

---

ClaimsCheck

Re-exports: ClaimsCheck

---

ClaimsCheckProps

Re-exports: ClaimsCheckProps

---

FirebaseAppProvider

Re-exports: FirebaseAppProvider

---

ObservableStatus

Re-exports: ObservableStatus

---

PreloadOptions

Re-exports: PreloadOptions

---

StorageImage

Re-exports: StorageImage

---

SuspensePerfProps

Re-exports: SuspensePerfProps

---

SuspenseWithPerf

Re-exports: SuspenseWithPerf

---

analytics

Re-exports: analytics

---

auth

Re-exports: auth

---

database

Re-exports: database

---

firestore

Re-exports: firestore

---

functions

Re-exports: functions

---

messaging

Re-exports: messaging

---

performance

Re-exports: performance

---

preloadAnalytics

Re-exports: preloadAnalytics

---

preloadAuth

Re-exports: preloadAuth

---

preloadDatabase

Re-exports: preloadDatabase

---

preloadFirestore

Re-exports: preloadFirestore

---

preloadFirestoreDoc

Re-exports: preloadFirestoreDoc

---

preloadFunctions

Re-exports: preloadFunctions

---

preloadMessaging

Re-exports: preloadMessaging

---

preloadObservable

Re-exports: preloadObservable

---

preloadPerformance

Re-exports: preloadPerformance

---

preloadRemoteConfig

Re-exports: preloadRemoteConfig

---

preloadStorage

Re-exports: preloadStorage

---

preloadUser

Re-exports: preloadUser

---

remoteConfig

Re-exports: remoteConfig

---

storage

Re-exports: storage

---

useAnalytics

Re-exports: useAnalytics

---

useAuth

Re-exports: useAuth

---

useDatabase

Re-exports: useDatabase

---

useDatabaseList

Re-exports: useDatabaseList

---

useDatabaseListData

Re-exports: useDatabaseListData

---

useDatabaseObject

Re-exports: useDatabaseObject

---

useDatabaseObjectData

Re-exports: useDatabaseObjectData

---

useFirebaseApp

Re-exports: useFirebaseApp

---

useFirestore

Re-exports: useFirestore

---

useFirestoreCollection

Re-exports: useFirestoreCollection

---

useFirestoreCollectionData

Re-exports: useFirestoreCollectionData

---

useFirestoreDoc

Re-exports: useFirestoreDoc

---

useFirestoreDocData

Re-exports: useFirestoreDocData

---

useFirestoreDocDataOnce

Re-exports: useFirestoreDocDataOnce

---

useFirestoreDocOnce

Re-exports: useFirestoreDocOnce

---

useFunctions

Re-exports: useFunctions

---

useIdTokenResult

Re-exports: useIdTokenResult

---

useIsSuspenseEnabled

Re-exports: useIsSuspenseEnabled

---

useMessaging

Re-exports: useMessaging

---

useObservable

Re-exports: useObservable

---

usePerformance

Re-exports: usePerformance

---

useRemoteConfig

Re-exports: useRemoteConfig

---

useRemoteConfigAll

Re-exports: useRemoteConfigAll

---

useRemoteConfigBoolean

Re-exports: useRemoteConfigBoolean

---

useRemoteConfigNumber

Re-exports: useRemoteConfigNumber

---

useRemoteConfigString

Re-exports: useRemoteConfigString

---

useRemoteConfigValue

Re-exports: useRemoteConfigValue

---

useStorage

Re-exports: useStorage

---

useStorageDownloadURL

Re-exports: useStorageDownloadURL

---

useStorageTask

Re-exports: useStorageTask

---

useSuspenseEnabledFromConfigAndContext

Re-exports: useSuspenseEnabledFromConfigAndContext

---

useUser

Re-exports: useUser

---

version

Re-exports: version

Type aliases

ReactFireGlobals

Ƭ ReactFireGlobals: { _reactFireDatabaseCachedQueries: Array<Query> ; _reactFireFirestoreQueryCache: Array<Query> ; _reactFirePreloadedObservables: Map<string, SuspenseSubject<any>> }

Defined in src/index.ts:4

Type declaration:

Name	Type
_reactFireDatabaseCachedQueries	Array<Query>
_reactFireFirestoreQueryCache	Array<Query>
_reactFirePreloadedObservables	Map<string, SuspenseSubject<any>>

Functions

checkIdField

▸ checkIdField(options: ReactFireOptions): any

Defined in src/index.ts:33

Parameters:

Name	Type
options	ReactFireOptions

Returns: any

---

checkOptions

▸ checkOptions(options: ReactFireOptions, field: string): any

Defined in src/index.ts:20

Parameters:

Name	Type
options	ReactFireOptions
field	string

Returns: any

---

checkinitialData

▸ checkinitialData(options: ReactFireOptions): any

Defined in src/index.ts:29

Parameters:

Name	Type
options	ReactFireOptions

Returns: any