QueryDocumentSnapshot class
Stay organized with collections
Save and categorize content based on your preferences.
A QueryDocumentSnapshot contains data read from a document in your Firestore database as part of a query. The document is guaranteed to exist and its data can be extracted with .data() or .get(<field>) to get a specific field.
A QueryDocumentSnapshot offers the same API surface as a DocumentSnapshot. Since query results contain only existing documents, the exists property will always be true and data() will never return 'undefined'.
Signature:
export declare class QueryDocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends DocumentSnapshot<AppModelType, DbModelType>
Extends: DocumentSnapshot<AppModelType, DbModelType>
Methods
| Method |
Modifiers |
Description |
| data(options) |
|
Retrieves all fields in the document as an Object.By default, serverTimestamp() values that have not yet been set to their final value will be returned as null. You can override this by passing an options object. |
QueryDocumentSnapshot.data()
Retrieves all fields in the document as an Object.
By default, serverTimestamp() values that have not yet been set to their final value will be returned as null. You can override this by passing an options object.
Signature:
/** @override */
data(options?: SnapshotOptions): AppModelType;
Parameters
| Parameter |
Type |
Description |
| options |
SnapshotOptions |
An options object to configure how data is retrieved from the snapshot (for example the desired behavior for server timestamps that have not yet been set to their final value). |
Returns:
AppModelType
An Object containing all fields in the document.
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 2024-01-19 UTC.
[null,null,["Last updated 2024-01-19 UTC."],[],[],null,["# QueryDocumentSnapshot class\n\nA `QueryDocumentSnapshot` contains data read from a document in your Firestore database as part of a query. The document is guaranteed to exist and its data can be extracted with `.data()` or `.get(\u003cfield\u003e)` to get a specific field.\n\nA `QueryDocumentSnapshot` offers the same API surface as a `DocumentSnapshot`. Since query results contain only existing documents, the `exists` property will always be true and `data()` will never return 'undefined'.\n\n**Signature:** \n\n export declare class QueryDocumentSnapshot\u003cAppModelType = DocumentData, DbModelType extends DocumentData = DocumentData\u003e extends DocumentSnapshot\u003cAppModelType, DbModelType\u003e \n\n**Extends:** [DocumentSnapshot](./firestore_.documentsnapshot.md#documentsnapshot_class)\\\u003cAppModelType, DbModelType\\\u003e\n\nMethods\n-------\n\n| Method | Modifiers | Description |\n|----------------------------------------------------------------------------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [data(options)](./firestore_.querydocumentsnapshot.md#querydocumentsnapshotdata) | | Retrieves all fields in the document as an `Object`.By default, `serverTimestamp()` values that have not yet been set to their final value will be returned as `null`. You can override this by passing an options object. |\n\nQueryDocumentSnapshot.data()\n----------------------------\n\nRetrieves all fields in the document as an `Object`.\n\nBy default, `serverTimestamp()` values that have not yet been set to their final value will be returned as `null`. You can override this by passing an options object.\n\n**Signature:** \n\n /** @override */\n data(options?: SnapshotOptions): AppModelType;\n\n#### Parameters\n\n| Parameter | Type | Description |\n|-----------|------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| options | [SnapshotOptions](./firestore_.snapshotoptions.md#snapshotoptions_interface) | An options object to configure how data is retrieved from the snapshot (for example the desired behavior for server timestamps that have not yet been set to their final value). |\n\n**Returns:**\n\nAppModelType\n\nAn `Object` containing all fields in the document."]]
