@janwuesten/firebase-admin-typescript v1.4.1

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

import { getFirestore } from "firebase-admin/firestore"
import { DocumentClass, DocumentClassDefineProps } from "@janwuesten/firebase-admin-typescript"

export class Account extends DocumentClass {
    username: string = ""
    firstName: string | null = null
    lastname: string | null = null

    definition({ define, defineCollection }: DocumentClassDefineProps): void {
        // Define a prop
        define("username", "string")
        define("firstName", "string")
        define("lastName", "string")

        // Define what collection will be used
        defineCollection(() => getFirestore().collection("account"))
    }
}

Web SDK

// firestore is the output of getFirestore()
import { firestore } from "@/firestore"

import { collection } from "firebase/firestore"
import { DocumentClass, DocumentClassDefineProps } from "@janwuesten/firebase-typescript"

export class Account extends DocumentClass {
    username: string = ""
    firstName: string | null = null
    lastname: string | null = null

    definition({ define, defineCollection }: DocumentClassDefineProps): void {
        // Define a prop
        define("username", "string")
        define("firstName", "string")
        define("lastName", "string")

        // Define what collection will be used
        defineCollection(() => collection(firestore, "account"))
    }
}

Setting or creating a document

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

Getting a document

const account = new Account("document id")
if (await account.get()) {
    console.log("Account does exist")
} else {
    console.log("Account does not exist")
}

Updating a document

const account = new Account("document id")
await account.get()
account.username = "MyNewUsername"
await account.update()
// You can also use:
// await account.set()

Deleting a document

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

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