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()] 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'.
QueryDocumentSnapshot DocumentSnapshot
Package
@google-cloud/firestore!Properties
createTime
/** @override */
get
createTime
()
:
Timestamp
;
The time the document was created.
{Timestamp} QueryDocumentSnapshot#createTime
Type | Description |
---|---|
Timestamp |
updateTime
/** @override */
get
updateTime
()
:
Timestamp
;
The time the document was last updated (at the time the snapshot was generated).
{Timestamp} QueryDocumentSnapshot#updateTime
Type | Description |
---|---|
Timestamp |
Methods
data()
/** @override */
data
()
:
T
;
Retrieves all fields in the document as an object.
Type | Description |
T | {T} An object containing all fields in the document. |