_sdk_.md

reactfire

Globals / "sdk"

Module: "sdk"

Index

Type aliases

• App
• ComponentName
• FirebaseInstanceFactory
• FirebaseNamespaceComponent
• PreloadOptions
• ValueOf

Variables

• 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

Functions

• importSDK
• preload
• preloadFactory
• proxyComponent

Type aliases

App

Ƭ App: App

Defined in src/sdk.tsx:8

---

ComponentName

Ƭ ComponentName: "analytics" | "auth" | "database" | "firestore" | "functions" | "messaging" | "performance" | "remoteConfig" | "storage"

Defined in src/sdk.tsx:5

---

FirebaseInstanceFactory

Ƭ FirebaseInstanceFactory: ValueOf<Pick<App, ComponentName>>

Defined in src/sdk.tsx:9

---

FirebaseNamespaceComponent

Ƭ FirebaseNamespaceComponent: ValueOf<Pick<typeof firebase, ComponentName>>

Defined in src/sdk.tsx:10

---

PreloadOptions

Ƭ PreloadOptions<T>: { firebaseApp: App ; setup?: undefined | (instanceFactory: T) => void | Promise<any> ; suspense?: undefined | false | true }

Defined in src/sdk.tsx:99

Type parameters:

Name
T

Type declaration:

Name	Type
firebaseApp	App
setup?	undefined | (instanceFactory: T) => void | Promise<any>
suspense?	undefined | false | true

---

ValueOf

Ƭ ValueOf<T>: T[keyof T]

Defined in src/sdk.tsx:7

Type parameters:

Name
T

Variables

analytics

• Const analytics: analytics = useAnalytics

Defined in src/sdk.tsx:90

---

auth

• Const auth: auth = useAuth

Defined in src/sdk.tsx:89

---

database

• Const database: database = useDatabase

Defined in src/sdk.tsx:91

---

firestore

• Const firestore: firestore = useFirestore

Defined in src/sdk.tsx:92

---

functions

• Const functions: functions = useFunctions

Defined in src/sdk.tsx:93

---

messaging

• Const messaging: messaging = useMessaging

Defined in src/sdk.tsx:94

---

performance

• Const performance: performance = usePerformance

Defined in src/sdk.tsx:95

---

preloadAnalytics

• Const preloadAnalytics: (options: PreloadOptions<App["analytics"]>) => Promise<App["analytics"]> = preloadFactory('analytics')

Defined in src/sdk.tsx:141

---

preloadAuth

• Const preloadAuth: (options: PreloadOptions<App["auth"]>) => Promise<App["auth"]> = preloadFactory('auth')

Defined in src/sdk.tsx:140

---

preloadDatabase

• Const preloadDatabase: (options: PreloadOptions<App["database"]>) => Promise<App["database"]> = preloadFactory('database')

Defined in src/sdk.tsx:142

---

preloadFirestore

• Const preloadFirestore: (options: PreloadOptions<App["firestore"]>) => Promise<App["firestore"]> = preloadFactory('firestore')

Defined in src/sdk.tsx:143

---

preloadFunctions

• Const preloadFunctions: (options: PreloadOptions<App["functions"]>) => Promise<App["functions"]> = preloadFactory('functions')

Defined in src/sdk.tsx:144

---

preloadMessaging

• Const preloadMessaging: (options: PreloadOptions<App["messaging"]>) => Promise<App["messaging"]> = preloadFactory('messaging')

Defined in src/sdk.tsx:145

---

preloadPerformance

• Const preloadPerformance: (options: PreloadOptions<App["performance"]>) => Promise<App["performance"]> = preloadFactory('performance')

Defined in src/sdk.tsx:146

---

preloadRemoteConfig

• Const preloadRemoteConfig: (options: PreloadOptions<App["remoteConfig"]>) => Promise<App["remoteConfig"]> = preloadFactory('remoteConfig')

Defined in src/sdk.tsx:147

---

preloadStorage

• Const preloadStorage: (options: PreloadOptions<App["storage"]>) => Promise<App["storage"]> = preloadFactory('storage')

Defined in src/sdk.tsx:148

---

remoteConfig

• Const remoteConfig: remoteConfig = useRemoteConfig

Defined in src/sdk.tsx:96

---

storage

• Const storage: storage = useStorage

Defined in src/sdk.tsx:97

---

useAnalytics

• Const useAnalytics: analytics = proxyComponent('analytics')

Defined in src/sdk.tsx:80

---

useAuth

• Const useAuth: auth = proxyComponent('auth')

Defined in src/sdk.tsx:79

---

useDatabase

• Const useDatabase: database = proxyComponent('database')

Defined in src/sdk.tsx:81

---

useFirestore

• Const useFirestore: firestore = proxyComponent('firestore')

Defined in src/sdk.tsx:82

---

useFunctions

• Const useFunctions: functions = proxyComponent('functions')

Defined in src/sdk.tsx:83

---

useMessaging

• Const useMessaging: messaging = proxyComponent('messaging')

Defined in src/sdk.tsx:84

---

usePerformance

• Const usePerformance: performance = proxyComponent('performance')

Defined in src/sdk.tsx:85

---

useRemoteConfig

• Const useRemoteConfig: remoteConfig = proxyComponent('remoteConfig')

Defined in src/sdk.tsx:86

---

useStorage

• Const useStorage: storage = proxyComponent('storage')

Defined in src/sdk.tsx:87

Functions

importSDK

▸ importSDK(sdk: ComponentName): Promise<any>

Defined in src/sdk.tsx:12

Parameters:

Name	Type
sdk	ComponentName

Returns: Promise<any>

---

preload

▸ preload(componentName: ComponentName, firebaseApp: App, settingsCallback?: (instanceFactory: FirebaseInstanceFactory) => any): SuspenseSubject<unknown>

Defined in src/sdk.tsx:118

Parameters:

Name	Type	Default value
componentName	ComponentName	-
firebaseApp	App	-
settingsCallback	(instanceFactory: FirebaseInstanceFactory) => any	() => {}

Returns: SuspenseSubject<unknown>

---

preloadFactory

▸ preloadFactory(componentName: "auth"): function

Defined in src/sdk.tsx:105

Parameters:

Name	Type
componentName	"auth"

Returns: function

▸ preloadFactory(componentName: "analytics"): function

Defined in src/sdk.tsx:106

Parameters:

Name	Type
componentName	"analytics"

Returns: function

▸ preloadFactory(componentName: "database"): function

Defined in src/sdk.tsx:107

Parameters:

Name	Type
componentName	"database"

Returns: function

▸ preloadFactory(componentName: "firestore"): function

Defined in src/sdk.tsx:108

Parameters:

Name	Type
componentName	"firestore"

Returns: function

▸ preloadFactory(componentName: "functions"): function

Defined in src/sdk.tsx:109

Parameters:

Name	Type
componentName	"functions"

Returns: function

▸ preloadFactory(componentName: "messaging"): function

Defined in src/sdk.tsx:110

Parameters:

Name	Type
componentName	"messaging"

Returns: function

▸ preloadFactory(componentName: "performance"): function

Defined in src/sdk.tsx:111

Parameters:

Name	Type
componentName	"performance"

Returns: function

▸ preloadFactory(componentName: "remoteConfig"): function

Defined in src/sdk.tsx:112

Parameters:

Name	Type
componentName	"remoteConfig"

Returns: function

▸ preloadFactory(componentName: "storage"): function

Defined in src/sdk.tsx:113

Parameters:

Name	Type
componentName	"storage"

Returns: function

---

proxyComponent

▸ proxyComponent(componentName: "auth"): typeof auth

Defined in src/sdk.tsx:35

Parameters:

Name	Type
componentName	"auth"

Returns: typeof auth

▸ proxyComponent(componentName: "analytics"): typeof analytics

Defined in src/sdk.tsx:36

Parameters:

Name	Type
componentName	"analytics"

Returns: typeof analytics

▸ proxyComponent(componentName: "database"): typeof database

Defined in src/sdk.tsx:37

Parameters:

Name	Type
componentName	"database"

Returns: typeof database

▸ proxyComponent(componentName: "firestore"): typeof firestore

Defined in src/sdk.tsx:38

Parameters:

Name	Type
componentName	"firestore"

Returns: typeof firestore

▸ proxyComponent(componentName: "functions"): typeof functions

Defined in src/sdk.tsx:39

Parameters:

Name	Type
componentName	"functions"

Returns: typeof functions

▸ proxyComponent(componentName: "messaging"): typeof messaging

Defined in src/sdk.tsx:40

Parameters:

Name	Type
componentName	"messaging"

Returns: typeof messaging

▸ proxyComponent(componentName: "performance"): typeof performance

Defined in src/sdk.tsx:41

Parameters:

Name	Type
componentName	"performance"

Returns: typeof performance

▸ proxyComponent(componentName: "remoteConfig"): typeof remoteConfig

Defined in src/sdk.tsx:42

Parameters:

Name	Type
componentName	"remoteConfig"

Returns: typeof remoteConfig

▸ proxyComponent(componentName: "storage"): typeof storage

Defined in src/sdk.tsx:43

Parameters:

Name	Type
componentName	"storage"

Returns: typeof storage