Skip to content

Latest commit

 

History

History
665 lines (379 loc) · 13 KB

index.md

File metadata and controls

665 lines (379 loc) · 13 KB

ReactFire reference docs / index

Module: index

Table of contents

References

Classes

Interfaces

Type aliases

Functions

References

AnalyticsProvider

Re-exports: AnalyticsProvider


AnalyticsSdkContext

Re-exports: AnalyticsSdkContext


AppCheckProvider

Re-exports: AppCheckProvider


AppCheckSdkContext

Re-exports: AppCheckSdkContext


AuthCheck

Re-exports: AuthCheck


AuthCheckProps

Re-exports: AuthCheckProps


AuthProvider

Re-exports: AuthProvider


AuthSdkContext

Re-exports: AuthSdkContext


ClaimCheckErrors

Re-exports: ClaimCheckErrors


ClaimsCheck

Re-exports: ClaimsCheck


ClaimsCheckProps

Re-exports: ClaimsCheckProps


ClaimsValidator

Re-exports: ClaimsValidator


DatabaseProvider

Re-exports: DatabaseProvider


DatabaseSdkContext

Re-exports: DatabaseSdkContext


FirebaseAppProvider

Re-exports: FirebaseAppProvider


FirestoreProvider

Re-exports: FirestoreProvider


FirestoreSdkContext

Re-exports: FirestoreSdkContext


FunctionsProvider

Re-exports: FunctionsProvider


FunctionsSdkContext

Re-exports: FunctionsSdkContext


ObservableStatus

Re-exports: ObservableStatus


PerformanceProvider

Re-exports: PerformanceProvider


PerformanceSdkContext

Re-exports: PerformanceSdkContext


RemoteConfigProvider

Re-exports: RemoteConfigProvider


RemoteConfigSdkContext

Re-exports: RemoteConfigSdkContext


SignInCheckOptionsBasic

Re-exports: SignInCheckOptionsBasic


SignInCheckOptionsClaimsObject

Re-exports: SignInCheckOptionsClaimsObject


SignInCheckOptionsClaimsValidator

Re-exports: SignInCheckOptionsClaimsValidator


SigninCheckResult

Re-exports: SigninCheckResult


StorageImage

Re-exports: StorageImage


StorageProvider

Re-exports: StorageProvider


StorageSdkContext

Re-exports: StorageSdkContext


SuspensePerfProps

Re-exports: SuspensePerfProps


SuspenseWithPerf

Re-exports: SuspenseWithPerf


preloadFirestoreDoc

Re-exports: preloadFirestoreDoc


preloadObservable

Re-exports: preloadObservable


preloadUser

Re-exports: preloadUser


useAnalytics

Re-exports: useAnalytics


useAppCheck

Re-exports: useAppCheck


useAuth

Re-exports: useAuth


useCallableFunctionResponse

Re-exports: useCallableFunctionResponse


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


useInitAnalytics

Re-exports: useInitAnalytics


useInitAppCheck

Re-exports: useInitAppCheck


useInitAuth

Re-exports: useInitAuth


useInitDatabase

Re-exports: useInitDatabase


useInitFirestore

Re-exports: useInitFirestore


useInitFunctions

Re-exports: useInitFunctions


useInitPerformance

Re-exports: useInitPerformance


useInitRemoteConfig

Re-exports: useInitRemoteConfig


useInitStorage

Re-exports: useInitStorage


useIsSuspenseEnabled

Re-exports: useIsSuspenseEnabled


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


useSigninCheck

Re-exports: useSigninCheck


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: Object

Type declaration

Name Type
_reactFireDatabaseCachedQueries DatabaseQuery[]
_reactFireFirestoreQueryCache FirestoreQuery[]
_reactFirePreloadedObservables Map<string, SuspenseSubject<any>>

Defined in

src/index.ts:6

Functions

checkIdField

checkIdField(options): any

Parameters

Name Type
options ReactFireOptions

Returns

any

Defined in

src/index.ts:47


checkOptions

checkOptions(options, field): any

Parameters

Name Type
options ReactFireOptions
field string

Returns

any

Defined in

src/index.ts:34


checkinitialData

checkinitialData(options): any

Parameters

Name Type
options ReactFireOptions

Returns

any

Defined in

src/index.ts:43