@firebase/firestore-types

What is @firebase/firestore-types?

The @firebase/firestore-types package provides TypeScript type definitions for Firebase Firestore. It is designed to help developers using TypeScript to have type-safe interactions with Firestore, ensuring that the code adheres to the expected types of Firestore's API.

What are @firebase/firestore-types's main functionalities?

Document Data Typing

This feature allows developers to extend the DocumentData type to define custom types for their documents, ensuring type safety when manipulating Firestore documents.

import { DocumentData } from '@firebase/firestore-types';

interface User extends DocumentData {
  name: string;
  age: number;
}

const user: User = { name: 'John Doe', age: 30 };

Query Typing

Developers can use types like Query and QuerySnapshot to handle Firestore queries with type safety, ensuring that the operations on queries are correctly typed.

import { Query, QuerySnapshot } from '@firebase/firestore-types';

function fetchUsers(query: Query): Promise<QuerySnapshot> {
  return query.get();
}

Transaction and Batch Typing

This feature provides types for Firestore transactions and batches, allowing developers to manage multiple document updates with type assurance.

import { Firestore, WriteBatch, Transaction } from '@firebase/firestore-types';

function updateMultipleDocs(firestore: Firestore) {
  const batch: WriteBatch = firestore.batch();
  const transaction: Transaction = firestore.runTransaction(async (t) => {
    // transaction logic here
  });
}

Other packages similar to @firebase/firestore-types

@types/node

Provides TypeScript definitions for Node.js. Similar in purpose to @firebase/firestore-types, but for Node.js environment instead of Firestore. It helps in developing Node.js applications with TypeScript by providing type definitions for various Node.js APIs.

@types/react

Offers TypeScript definitions for React. Like @firebase/firestore-types, it serves to enhance development in TypeScript by providing accurate types for React APIs, aiding in the development of type-safe React applications.

README

@firebase/firestore-types

This package is not intended for direct usage, and should only be used via the officially supported firebase package.