FirebaseExtended / FirebaseExtended/rxfire

[exp] Firestore rxfire function names match Firebase SDK names

Open
#21 2 comments 5 reactions 2 assignees Claimed by @davideast View on GitHub
Dominant language
TypeScript
Stars
149
Forks
50
PR merge metrics
No merged PRs in 30d

Description

In v9 of the Firebase SDK, `firebase/firestore` exports [`doc`](https://firebase.google.com/docs/reference/js/v9/firestore_.md#doc) and [`collection`](https://firebase.google.com/docs/reference/js/v9/firestore_.md#collection) as functions. It may be confusing for developers to have to always remember to be careful with their imports. For example, they'd have to do:

```ts
import { doc } from "firebase/firestore";
import { doc as doc$ } from "rxfire/firestore";

const colorDoc = doc(firestoreInstance, "colors", "blue");
doc$.subscribe(colorDoc, () => {
/* ... */
});
```

Maybe we should change the names of rxfire's `doc` and `collection`? Maybe `docSnapshots` and `querySnapshots`?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.