typesafe-node-firestore

typesafe-node-firestore

A library of typescript interfaces that extend existing firestore classes, adding type safety and a better autocomplete experience.

This library is for use with @google-cloud/firestore, while the library its based on is intended for the browser-based Javascript Firestore library.

Based on typesafe-firestore.

Installation

npm install typesafe-node-firestore --save-dev

Usage

You most likely want to import TypedCollectionReference and create your collections as shown below.

import * as firestore from "@google-cloud/firestore";
import { TypedCollectionReference } from "typesafe-node-firestore";

interface Author {
  penName: string;
  shortBiography: string;
  posts: string[];
}

// Create a new client
const firestore = new Firestore();

const AuthorCollection = firestore.collection(
  "authors"
) as TypedCollectionReference<Author>;

And then you can use your typesafe collection the same ways you would use the regular firestore library.

// OK
AuthorCollection.add({
  penName: "",
  shortBiography: "",
  posts: []
});

// TS2322: Type 'number' is not assignable to type 'string'.
AuthorCollection.add({
  penName: 11,
  shortBiography: "",
  posts: []
});

// OK
AuthorCollection.where("penName", "<=", "Barfunk");

// TS2345: Argument of type '"realName"' is not assignable to parameter of type '"penName" | "shortBiography" | "posts" | FieldPath'.
AuthorCollection.where("realName", "<=", "Barfunk");

License

typesafe-node-firestore is MIT licensed.

Changelog

<small>1.4.1 (2023-04-07)</small>

• chore: bump firestore to 6.5.0 (33bfe62)
• chore: release 1.4.0 (cfb3a30)
• chore: tag 1.4.1 (a5e937c)
• chore(deps): bump @grpc/grpc-js from 1.1.6 to 1.1.8 (6a2bedb)
• chore(deps): bump ajv from 6.10.2 to 6.12.6 (16c246c)
• chore(deps): bump ansi-regex from 4.1.0 to 4.1.1 (6be5f72)
• chore(deps): bump glob-parent from 5.1.0 to 5.1.2 (8e8e153)
• chore(deps): bump lodash from 4.17.19 to 4.17.21 (c1ce26f)
• chore(deps): bump minimist and mkdirp (23f5b71)
• chore(deps): bump node-fetch from 2.6.1 to 2.6.7 (6cf894b)
• chore(deps): bump node-forge and google-p12-pem (7c3fb26)
• chore(deps): bump protobufjs from 6.10.1 to 6.11.3 (ac70e6f)
• feat: add docs (e34af66)