Class QueryDocumentSnapshot (6.4.1)

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()] 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

Inheritance

DocumentSnapshot<T> > QueryDocumentSnapshot

Package

@google-cloud/firestore

Properties

createTime

/** @override */
get createTime(): Timestamp;

The time the document was created.

{Timestamp} QueryDocumentSnapshot#createTime

Example

let query = firestore.collection('col');

query.get().forEach(snapshot => {
  console.log(`Document created at '${snapshot.createTime.toDate()}'`);
});

updateTime

/** @override */
get updateTime(): Timestamp;

The time the document was last updated (at the time the snapshot was generated).

{Timestamp} QueryDocumentSnapshot#updateTime

Example

let query = firestore.collection('col');

query.get().forEach(snapshot => {
  console.log(`Document updated at '${snapshot.updateTime.toDate()}'`);
});

Methods

data()

/** @override */
data(): T;

Retrieves all fields in the document as an object.

Returns
TypeDescription
T

{T} An object containing all fields in the document.

Example

let query = firestore.collection('col');

query.get().forEach(documentSnapshot => {
  let data = documentSnapshot.data();
  console.log(`Retrieved data: ${JSON.stringify(data)}`);
});