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'.
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.
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).
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-01-19 UTC."],[],[],null,["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(\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\nQueryDocumentSnapshot.data()\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\nParameters\n\n**Returns:**\n\nAppModelType\n\nAn `Object` containing all fields in the document."]]