Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 486 Commits
.github/workflows		.github/workflows
auth		auth
database		database
docs		docs
firestore		firestore
functions		functions
performance		performance
remote-config		remote-config
storage		storage
test		test
.eslintrc.js		.eslintrc.js
.firebaserc		.firebaserc
.gitattributes		.gitattributes
.gitignore		.gitignore
.yarnrc.yml		.yarnrc.yml
CHANGELOG.md		CHANGELOG.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
babel.config.js		babel.config.js
build.sh		build.sh
database.rules.json		database.rules.json
firebase.json		firebase.json
index.ts		index.ts
package.json		package.json
rollup.config.js		rollup.config.js
test-debug.sh		test-debug.sh
tsconfig.json		tsconfig.json
yarn.lock		yarn.lock

Repository files navigation

RxFire

Firebase and RxJS for all frameworks.

What is RxFire?

Observable creators - Observables bindings for most Firebase web libraries.
Portable - Use across any framework or no framework at all.
Tree shake-able - Import only what you need. Shake the rest out with your favorite module bundler like Webpack or Rollup.
Combine multiple data sources - Need to join two Firestore references? Want to combine an image from Cloud Storage with a Firestore document? Super easy with observables and operators.
Simplify code-splitting of Firebase - Using RxFire with Webpack makes it easy to load Firebase features on-demand.

Status: Beta

Install

# npmnpm i rxfire firebase rxjs --save# yarnyarn add rxfire firebase rxjs

Make sure to install Firebase and RxJS individually as they are peer dependencies of RxFire.

Example use:

import{initializeApp}from'firebase/app';import{getFirestore,collection,where,query}from'firebase/firestore';import{collectionData}from'rxfire/firestore';import{tap}from'rxjs/operators';constapp=initializeApp({/* config */});constfirestore=getFirestore(app);constcitiesRef=query(collection(firestore,'cities'),where('state','==','CO'));collectionData(citiesRef,{idField:'id'}).pipe(tap(cities=>console.log('This is just an observable!'))).subscribe(cities=>{/* update UI */})

Easily combine multiple Firebase data sources

RxJS provides multiple operators and creation methods for combining observable streams. This makes it easy to combine data from multiple Firebase resources. You can also handle simplify high asynchronous tasks like joins into a flat stream.

The example below streams a list of "cities" from Firestore and then retrieves their image from a Cloud Storage bucket. Both tasks are asynchronous but RxJS makes it easy to combine these tasks together.

import{initializeApp}from'firebase/app';import{getStorage,ref}from'firebase/storage';import{getFirestore,collection,where,query}from'firebase/firestore';import{collectionData}from'rxfire/firestore';import{getDownloadURL}from'rxfire/storage';import{combineLatest}from'rxjs';import{switchMap}from'rxjs/operators';constapp=initializeApp({/* config */});constfirestore=getFirestore(app);conststorage=getStorage(app);constcitiesRef=query(collection(firestore,'cities'),where('state','==','CO'));collectionData(citiesRef,{idField:'id'}).pipe(switchMap(cities=>{returncombineLatest(...cities.map(c=>{constref=ref(storage,`/cities/${c.id}.png`);returngetDownloadURL(ref).pipe(map(imageURL=>({ imageURL, ...c})));}));})).subscribe(cities=>{cities.forEach(c=>console.log(c.imageURL));});

Understanding RxFire imports

RxFire is a complementary library to Firebase. It is not meant to wrap the entire Firebase SDK. RxFire's purpose is to simplify async streams from Firebase. You need to import the Firebase SDK and initialize an app before using RxFire.

import{initializeApp}from'firebase/app';import{getStorage,ref}from'firebase/storage';import{getDownloadURL}from'rxfire/storage';constapp=initializeApp({/* config */});conststorage=getStorage(app);constref=ref(storage,'data.json');// Now you can use RxFire!consturl$=getDownloadURL(ref);

RxFire contains multiple entry points for module imports. Each Firebase library is an entry point.

import{}from'rxfire/firestore';import{}from'rxfire/database';import{}from'rxfire/storage';import{}from'rxfire/auth';import{}from'rxfire/functions';import{}from'rxfire/performance';import{}from'rxfire/remote-config';

Simple functions

RxFire is a set of functions. Most functions create observables and from there you can use regular RxJS operators. Some functions are custom operators. But at the end of the day, it's all just functions. This is important fortree shaking. Any unused functions are stripped from your final build if you use a module bundler like Webpack or Rollup.

import{initializeApp}from'firebase/app';import{getStorage,ref}from'firebase/storage';import{getDownloadURL,put/* not used! */}'rxfire/storage';constapp=initializeApp({/* config */});conststorage=getStorage(app);constref=ref(storage,'data.json');consturl$=getDownloadURL(ref);