Firebase for TypeScript

Introduction

When working with Firebase and TypeScript creating Classes for Firestore Documents can be a bit annoying. As there is not standard way of parsing and writing your Class to a Firestore Document, every project uses an different way.

The Firebase for TypeScript will change that by providing a standard way of using Classes that can then be stored into the Firestore Database. It makes creating, reading and maintaining Firestore Document Classes easy and consistent across projects.

Installation

Installation for Admin SDK (Functions, backend etc.)

npm install firebase-admin @janwuesten/firebase-admin-typescript

Installation for Web SDK (requires Web version 9)

npm install firebase @janwuesten/firebase-typescript

Installation for react native

Visit the documentation on GitHub Wiki to view installation steps for react native.

Basic usage example

Admin SDK

1import { getFirestore } from "firebase-admin/firestore"
2import { DocumentClass, DocumentClassDefineProps } from "@janwuesten/firebase-admin-typescript"
3
4export class Account extends DocumentClass {
5    username: string = ""
6    firstName: string | null = null
7    lastname: string | null = null
8
9    definition({ define, defineCollection }: DocumentClassDefineProps): void {
10        // Define a prop
11        define("username", "string")
12        define("firstName", "string")
13        define("lastName", "string")
14
15        // Define what collection will be used
16        defineCollection(() => getFirestore().collection("account"))
17    }
18}

Web SDK

1// firestore is the output of getFirestore()
2import { firestore } from "@/firestore"
3
4import { collection } from "firebase/firestore"
5import { DocumentClass, DocumentClassDefineProps } from "@janwuesten/firebase-typescript"
6
7export class Account extends DocumentClass {
8    username: string = ""
9    firstName: string | null = null
10    lastname: string | null = null
11
12    definition({ define, defineCollection }: DocumentClassDefineProps): void {
13        // Define a prop
14        define("username", "string")
15        define("firstName", "string")
16        define("lastName", "string")
17
18        // Define what collection will be used
19        defineCollection(() => collection(firestore, "account"))
20    }
21}

Setting or creating a document

1const account = new Account()
2account.username = "MyUsername"
3await account.set()
4// Created document ID:
5console.log(account.id)

Getting a document

1const account = new Account("document id")
2if (await account.get()) {
3    console.log("Account does exist")
4} else {
5    console.log("Account does not exist")
6}

Updating a document

1const account = new Account("document id")
2await account.get()
3account.username = "MyNewUsername"
4await account.update()
5// You can also use:
6// await account.set()

Deleting a document

1const account = new Account("document id")
2await account.delete()

For more information on how to use firebase-typescript with all its features visit the documentation on GitHub Wiki here.