-
Notifications
You must be signed in to change notification settings - Fork 909
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* RxFire is moving to its own repo * Updating link Co-authored-by: Feiyang1 <plane1113@gmail.com>
- Loading branch information
1 parent
1f3bdec
commit e689ff6
Showing
41 changed files
with
14 additions
and
3,196 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| name: Test rxFire and @firebase/rules-unit-testing | ||
| name: Test @firebase/rules-unit-testing | ||
|
|
||
| on: pull_request | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,126 +1,3 @@ | ||
| # 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 | ||
|
|
||
| ```bash | ||
| # npm | ||
| npm i rxfire firebase rxjs --save | ||
| # yarn | ||
| yarn add rxfire firebase rxjs | ||
| ``` | ||
|
|
||
| Make sure to install Firebase and RxJS individually as they are peer dependencies of RxFire. | ||
|
|
||
| ## Example use: | ||
|
|
||
| ```ts | ||
| import firebase from 'firebase/app'; | ||
| import 'firebase/firestore'; | ||
| import { collectionData } from 'rxfire/firestore'; | ||
| import { tap } from 'rxjs/operators'; | ||
|
|
||
| const app = firebase.initializeApp({ /* config */ }); | ||
| const citiesRef = app.firestore().collection('cities'); | ||
| citiesRef.where('state', '==', 'CO'); | ||
|
|
||
| collectionData(citiesRef, '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. | ||
|
|
||
| ```ts | ||
| import firebase from 'firebase/app'; | ||
| import 'firebase/firestore'; | ||
| import 'firebase/storage'; | ||
| import { collectionData } from 'rxfire/firestore'; | ||
| import { getDownloadURL } from 'rxfire/storage'; | ||
| import { switchMap } from 'rxjs/operators'; | ||
|
|
||
| const app = firebase.initializeApp({ /* config */ }); | ||
| const citiesRef = app.firestore().collection('cities'); | ||
| citiesRef.where('state', '==', 'CO'); | ||
|
|
||
| collectionData(citiesRef, 'id') | ||
| .pipe( | ||
| switchMap(cities => { | ||
| return combineLatest(...cities.map(c => { | ||
| const ref = storage.ref(`/cities/${c.id}.png`); | ||
| return getDownloadURL(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. | ||
|
|
||
| ```ts | ||
| import firebase from 'firebase/app'; | ||
| import 'firebase/storage'; // import only the features needed | ||
| import { getDownloadURL } from 'rxfire/storage'; | ||
|
|
||
| const app = firebase.initializeApp({ /* config */ }); | ||
| const ref = app.storage().ref('data.json'); | ||
|
|
||
| // Now you can use RxFire! | ||
| const url$ = getDownloadURL(ref); | ||
| ``` | ||
|
|
||
| RxFire contains multiple entry points for module imports. Each Firebase library is an entry point. | ||
|
|
||
| ```ts | ||
| import { } from 'rxfire/firestore'; | ||
| import { } from 'rxfire/database'; | ||
| import { } from 'rxfire/storage'; | ||
| import { } from 'rxfire/auth'; | ||
| import { } from 'rxfire/functions'; | ||
| ``` | ||
|
|
||
| ## 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 for **tree shaking**. Any unused functions are stripped from your final build if you use a module bundler like Webpack or Rollup. | ||
|
|
||
| ```ts | ||
| import firebase from 'firebase/app'; | ||
| import 'firebase/storage'; | ||
| import { getDownloadURL, put /* not used! */ } 'rxfire/storage'; | ||
|
|
||
| const app = firebase.initializeApp({ /* config */ }); | ||
| const ref = app.storage().ref('data.json'); | ||
|
|
||
| const url$ = getDownloadURL(ref); | ||
| ``` | ||
| ## Documentation | ||
| - [Firestore](https://github.com/firebase/firebase-js-sdk/blob/master/packages/rxfire/docs/firestore.md) | ||
| - [Authentication](https://github.com/firebase/firebase-js-sdk/blob/master/packages/rxfire/docs/auth.md) | ||
| - [Storage](https://github.com/firebase/firebase-js-sdk/blob/master/packages/rxfire/docs/storage.md) | ||
| - [Realtime Database](https://github.com/firebase/firebase-js-sdk/blob/master/packages/rxfire/docs/database.md) | ||
| ## Examples | ||
| [Examples](https://github.com/davideast/rxfire-samples): See this example repository for a list of ways to configure and use RxFire. | ||
| RxFire has moved to its own repository, you can find it here [firebaseextended/rxfire](https://github.com/firebaseextended/rxfire). |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.