Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

QueryDocumentSnapshot class

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'.

<b>Signature:</b>

export declare class QueryDocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends DocumentSnapshot<AppModelType, DbModelType> 

<b>Extends:</b> DocumentSnapshot<!-- --><AppModelType, DbModelType>

Methods

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.

<b>Signature:</b>

/** @override */
data(options?: SnapshotOptions): AppModelType;

Parameters

<b>Returns:</b>

AppModelType

An Object containing all fields in the document.