Back to Firebase Js Sdk

Firestore class

docs-devsite/firestore_pipelines.firestore.md

12.12.11.8 KB
Original Source

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

Firestore class

The Cloud Firestore service interface.

Do not call this constructor directly. Instead, use getFirestore()<!-- -->.

<b>Signature:</b>

typescript
export declare class Firestore 

Properties

PropertyModifiersTypeDescription
appFirebaseAppThe FirebaseApp associated with this <code>Firestore</code> service instance.
type'firestore-lite' | 'firestore'Whether it's a Firestore or Firestore Lite instance.

Methods

MethodModifiersDescription
toJSON()Returns a JSON-serializable representation of this <code>Firestore</code> instance.

Firestore.app

The FirebaseApp associated with this Firestore service instance.

<b>Signature:</b>

typescript
get app(): FirebaseApp;

Firestore.type

Whether it's a Firestore or Firestore Lite instance.

<b>Signature:</b>

typescript
type: 'firestore-lite' | 'firestore';

Firestore.toJSON()

Returns a JSON-serializable representation of this Firestore instance.

<b>Signature:</b>

typescript
toJSON(): object;

<b>Returns:</b>

object