_firebaseapp_.md

reactfire

Globals / "firebaseApp"

Module: "firebaseApp"

Index

References

• PreloadOptions
• analytics
• auth
• database
• firestore
• functions
• messaging
• performance
• preloadAnalytics
• preloadAuth
• preloadDatabase
• preloadFirestore
• preloadFunctions
• preloadMessaging
• preloadPerformance
• preloadRemoteConfig
• preloadStorage
• remoteConfig
• storage
• useAnalytics
• useAuth
• useDatabase
• useFirestore
• useFunctions
• useMessaging
• usePerformance
• useRemoteConfig
• useStorage

Type aliases

• FirebaseAppContextValue
• Props

Variables

• DEFAULT_APP_NAME
• FirebaseAppContext
• SuspenseEnabledContext
• version

Functions

• FirebaseAppProvider
• shallowEq
• useFirebaseApp
• useIsSuspenseEnabled
• useSuspenseEnabledFromConfigAndContext

References

PreloadOptions

Re-exports: PreloadOptions

---

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

---

preloadFunctions

Re-exports: preloadFunctions

---

preloadMessaging

Re-exports: preloadMessaging

---

preloadPerformance

Re-exports: preloadPerformance

---

preloadRemoteConfig

Re-exports: preloadRemoteConfig

---

preloadStorage

Re-exports: preloadStorage

---

remoteConfig

Re-exports: remoteConfig

---

storage

Re-exports: storage

---

useAnalytics

Re-exports: useAnalytics

---

useAuth

Re-exports: useAuth

---

useDatabase

Re-exports: useDatabase

---

useFirestore

Re-exports: useFirestore

---

useFunctions

Re-exports: useFunctions

---

useMessaging

Re-exports: useMessaging

---

usePerformance

Re-exports: usePerformance

---

useRemoteConfig

Re-exports: useRemoteConfig

---

useStorage

Re-exports: useStorage

Type aliases

FirebaseAppContextValue

Ƭ FirebaseAppContextValue: App

Defined in src/firebaseApp.tsx:6

---

Props

Ƭ Props: { appName?: undefined | string ; firebaseApp?: firebase.app.App ; firebaseConfig?: Object ; suspense?: undefined | false | true }

Defined in src/firebaseApp.tsx:15

Type declaration:

Name	Type
appName?	undefined | string
firebaseApp?	firebase.app.App
firebaseConfig?	Object
suspense?	undefined | false | true

Variables

DEFAULT_APP_NAME

• Const DEFAULT_APP_NAME: "[DEFAULT]" = "[DEFAULT]"

Defined in src/firebaseApp.tsx:9

---

FirebaseAppContext

• Const FirebaseAppContext: Context<undefined | App> = React.createContext<FirebaseAppContextValue | undefined>(undefined)

Defined in src/firebaseApp.tsx:11

---

SuspenseEnabledContext

• Const SuspenseEnabledContext: Context<boolean> = React.createContext<boolean>(false)

Defined in src/firebaseApp.tsx:13

---

version

• Const version: any = __REACTFIRE_VERSION__

Defined in src/firebaseApp.tsx:23

Functions

FirebaseAppProvider

▸ FirebaseAppProvider(props: Props & { [key:string]: unknown; }): Element

Defined in src/firebaseApp.tsx:27

Parameters:

Name	Type
props	Props & { [key:string]: unknown; }

Returns: Element

---

shallowEq

▸ ConstshallowEq(a: { [key:string]: any; }, b: { [key:string]: any; }): boolean

Defined in src/firebaseApp.tsx:25

Parameters:

Name	Type
a	{ [key:string]: any; }
b	{ [key:string]: any; }

Returns: boolean

---

useFirebaseApp

▸ useFirebaseApp(): App

Defined in src/firebaseApp.tsx:82

Returns: App

---

useIsSuspenseEnabled

▸ useIsSuspenseEnabled(): boolean

Defined in src/firebaseApp.tsx:64

Returns: boolean

---

useSuspenseEnabledFromConfigAndContext

▸ useSuspenseEnabledFromConfigAndContext(suspenseFromConfig?: undefined | false | true): boolean

Defined in src/firebaseApp.tsx:71

Parameters:

Name	Type
suspenseFromConfig?	undefined | false | true

Returns: boolean