sdk.md

ReactFire reference docs / sdk

Module: sdk

Table of contents

Variables

• AnalyticsSdkContext
• AppCheckSdkContext
• AuthSdkContext
• DatabaseSdkContext
• FirestoreSdkContext
• FunctionsSdkContext
• PerformanceSdkContext
• RemoteConfigSdkContext
• StorageSdkContext

Functions

• AnalyticsProvider
• AppCheckProvider
• AuthProvider
• DatabaseProvider
• FirestoreProvider
• FunctionsProvider
• PerformanceProvider
• RemoteConfigProvider
• StorageProvider
• useAnalytics
• useAppCheck
• useAuth
• useDatabase
• useFirestore
• useFunctions
• useInitAnalytics
• useInitAppCheck
• useInitAuth
• useInitDatabase
• useInitFirestore
• useInitFunctions
• useInitPerformance
• useInitRemoteConfig
• useInitStorage
• usePerformance
• useRemoteConfig
• useStorage

Variables

AnalyticsSdkContext

• Const AnalyticsSdkContext: Context<undefined | Analytics>

Defined in

src/sdk.tsx:20

---

AppCheckSdkContext

• Const AppCheckSdkContext: Context<undefined | AppCheck>

Defined in

src/sdk.tsx:18

---

AuthSdkContext

• Const AuthSdkContext: Context<undefined | Auth>

Defined in

src/sdk.tsx:19

---

DatabaseSdkContext

• Const DatabaseSdkContext: Context<undefined | Database>

Defined in

src/sdk.tsx:21

---

FirestoreSdkContext

• Const FirestoreSdkContext: Context<undefined | Firestore>

Defined in

src/sdk.tsx:22

---

FunctionsSdkContext

• Const FunctionsSdkContext: Context<undefined | Functions>

Defined in

src/sdk.tsx:23

---

PerformanceSdkContext

• Const PerformanceSdkContext: Context<undefined | FirebasePerformance>

Defined in

src/sdk.tsx:25

---

RemoteConfigSdkContext

• Const RemoteConfigSdkContext: Context<undefined | RemoteConfig>

Defined in

src/sdk.tsx:26

---

StorageSdkContext

• Const StorageSdkContext: Context<undefined | FirebaseStorage>

Defined in

src/sdk.tsx:24

Functions

AnalyticsProvider

▸ Const AnalyticsProvider(props): Element

Parameters

Name	Type
props	PropsWithChildren<Object>

Returns

Element

Defined in

src/sdk.tsx:74

---

AppCheckProvider

▸ Const AppCheckProvider(props): Element

Parameters

Name	Type
props	PropsWithChildren<Object>

Returns

Element

Defined in

src/sdk.tsx:72

---

AuthProvider

▸ Const AuthProvider(props): Element

Parameters

Name	Type
props	PropsWithChildren<Object>

Returns

Element

Defined in

src/sdk.tsx:73

---

DatabaseProvider

▸ Const DatabaseProvider(props): Element

Parameters

Name	Type
props	PropsWithChildren<Object>

Returns

Element

Defined in

src/sdk.tsx:75

---

FirestoreProvider

▸ Const FirestoreProvider(props): Element

Parameters

Name	Type
props	PropsWithChildren<Object>

Returns

Element

Defined in

src/sdk.tsx:76

---

FunctionsProvider

▸ Const FunctionsProvider(props): Element

Parameters

Name	Type
props	PropsWithChildren<Object>

Returns

Element

Defined in

src/sdk.tsx:77

---

PerformanceProvider

▸ Const PerformanceProvider(props): Element

Parameters

Name	Type
props	PropsWithChildren<Object>

Returns

Element

Defined in

src/sdk.tsx:78

---

RemoteConfigProvider

▸ Const RemoteConfigProvider(props): Element

Parameters

Name	Type
props	PropsWithChildren<Object>

Returns

Element

Defined in

src/sdk.tsx:80

---

StorageProvider

▸ Const StorageProvider(props): Element

Parameters

Name	Type
props	PropsWithChildren<Object>

Returns

Element

Defined in

src/sdk.tsx:79

---

useAnalytics

▸ Const useAnalytics(): Analytics

Returns

Analytics

Defined in

src/sdk.tsx:84

---

useAppCheck

▸ Const useAppCheck(): AppCheck

Returns

AppCheck

Defined in

src/sdk.tsx:82

---

useAuth

▸ Const useAuth(): Auth

Returns

Auth

Defined in

src/sdk.tsx:83

---

useDatabase

▸ Const useDatabase(): Database

Returns

Database

Defined in

src/sdk.tsx:85

---

useFirestore

▸ Const useFirestore(): Firestore

Returns

Firestore

Defined in

src/sdk.tsx:86

---

useFunctions

▸ Const useFunctions(): Functions

Returns

Functions

Defined in

src/sdk.tsx:87

---

useInitAnalytics

▸ Const useInitAnalytics(initializer, options?): ObservableStatus<Analytics>

Parameters

Name	Type
initializer	(firebaseApp: FirebaseApp) => Promise<Analytics>
options?	ReactFireOptions<Analytics>

Returns

ObservableStatus<Analytics>

Defined in

src/sdk.tsx:99

---

useInitAppCheck

▸ Const useInitAppCheck(initializer, options?): ObservableStatus<AppCheck>

Parameters

Name	Type
initializer	(firebaseApp: FirebaseApp) => Promise<AppCheck>
options?	ReactFireOptions<AppCheck>

Returns

ObservableStatus<AppCheck>

Defined in

src/sdk.tsx:97

---

useInitAuth

▸ Const useInitAuth(initializer, options?): ObservableStatus<Auth>

Parameters

Name	Type
initializer	(firebaseApp: FirebaseApp) => Promise<Auth>
options?	ReactFireOptions<Auth>

Returns

ObservableStatus<Auth>

Defined in

src/sdk.tsx:98

---

useInitDatabase

▸ Const useInitDatabase(initializer, options?): ObservableStatus<Database>

Parameters

Name	Type
initializer	(firebaseApp: FirebaseApp) => Promise<Database>
options?	ReactFireOptions<Database>

Returns

ObservableStatus<Database>

Defined in

src/sdk.tsx:100

---

useInitFirestore

▸ Const useInitFirestore(initializer, options?): ObservableStatus<Firestore>

Parameters

Name	Type
initializer	(firebaseApp: FirebaseApp) => Promise<Firestore>
options?	ReactFireOptions<Firestore>

Returns

ObservableStatus<Firestore>

Defined in

src/sdk.tsx:101

---

useInitFunctions

▸ Const useInitFunctions(initializer, options?): ObservableStatus<Functions>

Parameters

Name	Type
initializer	(firebaseApp: FirebaseApp) => Promise<Functions>
options?	ReactFireOptions<Functions>

Returns

ObservableStatus<Functions>

Defined in

src/sdk.tsx:102

---

useInitPerformance

▸ Const useInitPerformance(initializer, options?): ObservableStatus<FirebasePerformance>

Parameters

Name	Type
initializer	(firebaseApp: FirebaseApp) => Promise<FirebasePerformance>
options?	ReactFireOptions<FirebasePerformance>

Returns

ObservableStatus<FirebasePerformance>

Defined in

src/sdk.tsx:103

---

useInitRemoteConfig

▸ Const useInitRemoteConfig(initializer, options?): ObservableStatus<RemoteConfig>

Parameters

Name	Type
initializer	(firebaseApp: FirebaseApp) => Promise<RemoteConfig>
options?	ReactFireOptions<RemoteConfig>

Returns

ObservableStatus<RemoteConfig>

Defined in

src/sdk.tsx:105

---

useInitStorage

▸ Const useInitStorage(initializer, options?): ObservableStatus<FirebaseStorage>

Parameters

Name	Type
initializer	(firebaseApp: FirebaseApp) => Promise<FirebaseStorage>
options?	ReactFireOptions<FirebaseStorage>

Returns

ObservableStatus<FirebaseStorage>

Defined in

src/sdk.tsx:107

---

usePerformance

▸ Const usePerformance(): FirebasePerformance

Returns

FirebasePerformance

Defined in

src/sdk.tsx:88

---

useRemoteConfig

▸ Const useRemoteConfig(): RemoteConfig

Returns

RemoteConfig

Defined in

src/sdk.tsx:90

---

useStorage

▸ Const useStorage(): FirebaseStorage

Returns

FirebaseStorage

Defined in

src/sdk.tsx:89