Firestore class
Stay organized with collections
Save and categorize content based on your preferences.
The Cloud Firestore service interface.
Do not call this constructor directly. Instead, use getFirestore().
Signature:
export declare class Firestore
Properties
| Property |
Modifiers |
Type |
Description |
| app |
|
FirebaseApp |
The FirebaseApp associated with this Firestore service instance. |
| type |
|
'firestore-lite' | 'firestore' |
Whether it's a Firestore or Firestore Lite instance. |
Methods
| Method |
Modifiers |
Description |
| toJSON() |
|
Returns a JSON-serializable representation of this Firestore instance. |
Firestore.app
The FirebaseApp associated with this Firestore service instance.
Signature:
get app(): FirebaseApp;
Firestore.type
Whether it's a Firestore or Firestore Lite instance.
Signature:
type: 'firestore-lite' | 'firestore';
Firestore.toJSON()
Returns a JSON-serializable representation of this Firestore instance.
Signature:
toJSON(): object;
Returns:
object
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-07-22 UTC.
[null,null,["Last updated 2022-07-22 UTC."],[],[],null,["# Firestore class\n\nThe Cloud Firestore service interface.\n\nDo not call this constructor directly. Instead, use [getFirestore()](./firestore_.md#getfirestore).\n\n**Signature:** \n\n export declare class Firestore \n\nProperties\n----------\n\n| Property | Modifiers | Type | Description |\n|-----------------------------------------------------|-----------|-----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|\n| [app](./firestore_lite.firestore.md#firestoreapp) | | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) associated with this `Firestore` service instance. |\n| [type](./firestore_lite.firestore.md#firestoretype) | | 'firestore-lite' \\| 'firestore' | Whether it's a Firestore or Firestore Lite instance. |\n\nMethods\n-------\n\n| Method | Modifiers | Description |\n|-----------------------------------------------------------|-----------|--------------------------------------------------------------------------|\n| [toJSON()](./firestore_lite.firestore.md#firestoretojson) | | Returns a JSON-serializable representation of this `Firestore` instance. |\n\nFirestore.app\n-------------\n\nThe [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) associated with this `Firestore` service instance.\n\n**Signature:** \n\n get app(): FirebaseApp;\n\nFirestore.type\n--------------\n\nWhether it's a Firestore or Firestore Lite instance.\n\n**Signature:** \n\n type: 'firestore-lite' | 'firestore';\n\nFirestore.toJSON()\n------------------\n\nReturns a JSON-serializable representation of this `Firestore` instance.\n\n**Signature:** \n\n toJSON(): object;\n\n**Returns:**\n\nobject"]]
