Using Firestore with Typescript - no examples

firestore.ts

/**
 * This Gist is part of a medium article - read here:
 * https://jamiecurnow.medium.com/using-firestore-with-typescript-65bd2a602945
 */

// import firstore (obviously)
import { firestore } from "firebase-admin"

// Import or define your types
// import { YourType } from '~/@types'


const converter = <T>() => ({
  toFirestore: (data: Partial<T>) => data,
  fromFirestore: (snap: FirebaseFirestore.QueryDocumentSnapshot) => snap.data() as T
})

const dataPoint = <T>(collectionPath: string) => firestore().collection(collectionPath).withConverter(converter<T>())

const db = {
  // list your collections here
  // users: dataPoint<YourType>('users')
}

export { db }
export default db

Just great, thank you @JamieCurnow !

This helped me get what I wanted:

import { FirestoreDataConverter } from "firebase-admin/firestore";
import { firestore } from "../server/firebase";
import { User } from "./User";

const converter = <T>(): FirestoreDataConverter<T> => ({
  toFirestore: (
    data: FirebaseFirestore.WithFieldValue<T>
  ): FirebaseFirestore.DocumentData => data as FirebaseFirestore.DocumentData,
  fromFirestore: (snap: FirebaseFirestore.QueryDocumentSnapshot) =>
    snap.data() as T,
});

// helpers
const collection = <T>(collectionPath: string) =>
  firestore.collection(collectionPath).withConverter(converter<T>());
const doc = <T>(docPath: string) =>
  firestore.doc(docPath).withConverter(converter<T>());

// new entries here
export const db = {
  users: collection<User>("users"),
  user: (id: string) => doc<User>(`users/${id}`),
};

// calling code
const userDocRef = db.user('123').get();
const userData: User = userDocRef.data();

Is anyone using the generic converter with VueFire? Would love to see how you adapted it to work with this: https://vuefire.vuejs.org/guide/realtime-data.html#Firestore-withConverter-