QueryDocumentSnapshot
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'.
class QueryDocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends DocumentSnapshot<AppModelType, DbModelType> {}
§Type Parameters
§
AppModelType = DocumentData
[src]§
DbModelType extends DocumentData = DocumentData
[src]§Methods
§
data(options?: SnapshotOptions): AppModelType
[src]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.
@param options
- 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).
@return
An Object containing all fields in the document.