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

This installation method support firebase for web, firebase admin and firebase for react native by default.

npm install @janwuesten/firebase-typescript

Keep in mind that you still need to install the firebase sdk for that environment. You can see more information in the Wiki.

Basic usage example

1import { getFirestore, collection } from "firebase/firestore"
2import { DocumentClass, DocumentClassDefineProps } from "@janwuesten/firebase-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, defineHandler }: DocumentClassDefineProps) {
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(() => collection(getFirestore(), "account"))
17
18        // Define the document class handler to set which firebase app is used
19        // and if this class if for web, admin or react native
20        // you can see example handlers for web, admin and react native in the wiki:
21        // https://github.com/janwuesten/firebase-typescript/wiki/2.1-%5BFirestore%5D-Create-document-class-handlers-and-batch-handlers
22        defineHandler(new MyClassHandler())
23    }
24}

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.