How to use TypeScript with Firebase Functions Gen 2 Firestore triggers?

How to use TypeScript with Firebase Functions Gen 2 Firestore triggers?

If you are working with TypeScript and Firebase Functions Gen 2, you may have encountered some challenges when trying to use Firestore triggers. In this blog post, we will explore different solutions to help you integrate TypeScript with Firebase Functions Gen 2 Firestore triggers.

Solution 1: Using the Firebase Admin SDK

The first solution involves using the Firebase Admin SDK to interact with Firestore triggers. Here’s how you can do it:


import * as functions from 'firebase-functions';
import * as admin from 'firebase-admin';

export const myFirestoreTrigger = functions.firestore
.document('myCollection/{docId}')
.onCreate(async (snapshot, context) => {
// Your trigger logic here
const data = snapshot.data();
const docId = context.params.docId;
console.log(New document created in myCollection with ID: ${docId});
});


This code sets up a Firestore trigger that listens for new documents created in the ‘myCollection’ collection. You can replace ‘myCollection’ with the actual name of your collection. Inside the trigger, you can access the document data using ‘snapshot.data()’ and the document ID using ‘context.params.docId’.

Solution 2: Using the firebase-functions-typescript package

If you prefer a more TypeScript-friendly approach, you can use the ‘firebase-functions-typescript’ package. Here’s how:


import * as functions from 'firebase-functions';
import { firestore } from 'firebase-functions-typescript';

export const myFirestoreTrigger = firestore
.document('myCollection/{docId}')
.onCreate(async (snapshot, context) => {
// Your trigger logic here
const data = snapshot.data();
const docId = context.params.docId;
console.log(New document created in myCollection with ID: ${docId});
});


This code achieves the same result as the previous solution but in a more TypeScript-friendly way. The ‘firebase-functions-typescript’ package provides TypeScript typings for Firebase Functions, making it easier to work with Firestore triggers.

Conclusion

Integrating TypeScript with Firebase Functions Gen 2 Firestore triggers can be a bit challenging, but with the right approach, it becomes much easier. In this blog post, we explored two solutions: using the Firebase Admin SDK and using the ‘firebase-functions-typescript’ package. Choose the solution that best fits your needs and start building powerful Firestore triggers with TypeScript.

For more information, you can refer to the official Firebase documentation on Firestore triggers:

https://firebase.google.com/docs/functions/firestore-events