https://github.com/narumincho/typed-firestore
stronger type for @firebase/firestore-types
https://github.com/narumincho/typed-firestore
Last synced: about 1 year ago
JSON representation
stronger type for @firebase/firestore-types
- Host: GitHub
- URL: https://github.com/narumincho/typed-firestore
- Owner: narumincho
- License: apache-2.0
- Created: 2019-12-05T22:20:57.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2023-06-29T14:32:02.000Z (about 3 years ago)
- Last Synced: 2025-03-15T18:51:15.174Z (over 1 year ago)
- Language: TypeScript
- Size: 80.1 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# typed-firestore
[](https://badge.fury.io/js/typed-firestore)
[](https://nodei.co/npm/typed-firestore/)
stronger type declaration for firebase firestore.
[typed-admin-firestore](https://github.com/narumincho/typed-admin-firestore)
## client
```ts
import * as firebase from "firebase/app";
import "firebase/firestore";
import type * as typedFirestore from "typed-firestore";
firebase.initializeApp({...});
const firestoreInstance = (firebase.firestore() as unknown) as f.Firestore<{
user: { key: UserId; value: User; subCollections: {} };
music: { key: MusicId; value: Music; subCollections: {} };
project: {
key: ProjectId;
value: Project;
subCollections: {
data:
| {
key: "Body";
value: { text: string };
subCollections: {};
}
| {
key: "Comments";
value: Comments;
subCollections: {};
};
};
};
}>;
type UserId = string & { _userId: never };
type User = {
name: string;
age: number;
openIdConnect: {
providerName: string;
idInProvider: string;
};
likedMusics: Array;
createdAt: firestore.Timestamp;
};
type MusicId = string & { _musicId: never };
type Music = {
title: string;
artist: UserId;
};
type ProjectId = string & { _projectId: never };
type Project = {
name: string;
createdBy: UserId;
};
type Comments = {
comments: ReadonlyArray<{
body: string;
createdBy: UserId;
createdAt: firestore.Timestamp;
}>;
};
(async () => {
const userQuerySnapshotArray = await firestoreInstance
.collection("user")
.where("age", "<=", 20)
.get();
for (const userQueryDocumentSnapshot of userQuerySnapshotArray.docs) {
const data = userQueryDocumentSnapshot.data();
console.log("name", data.name); // Type hint !!!!!
console.log("providerName", data.openIdConnect.providerName); // Type hint !!!!!
for (const likedMusicId of data.likedMusics) {
firestoreInstance.collection("music").doc(likedMusicId); // no error !!!
firestoreInstance.collection("user").doc(likedMusicId); // error !!!
}
}
const commentDoc = await firestoreInstance
.collection("project") // autocomplete
.doc("6b9495528e9a12186b9c210448bdc90b" as ProjectId)
.collection("data") // autocomplete
.doc("Comments") // autocomplete
.get(); // returns DocumentSnapshot of Comments
})();
```