The Firebase JS SDK is now in BETA!
This EAP site is no longer maintained. See the official Firebase Documentation site for the latest documentation and information about the Firebase JS SDK.

Home > @firebase/firestore > / > DocumentSnapshot

DocumentSnapshot class

A DocumentSnapshot contains data read from a document in your Firestore database. The data can be extracted with .data() or .get(<field>) to get a specific field.

For a DocumentSnapshot that points to a non-existing document, any data access will return 'undefined'. You can use the exists() method to explicitly verify a document's existence.

Signature:

export declare class DocumentSnapshot<T = DocumentData> 

Constructors

Constructor Modifiers Description
(constructor)() Constructs a new instance of the DocumentSnapshot class

Properties

Property Modifiers Type Description
id string Property of the DocumentSnapshot that provides the document's ID.
metadata SnapshotMetadata Metadata about the DocumentSnapshot, including information about its source and local modifications.
ref DocumentReference<T> The DocumentReference for the document included in the DocumentSnapshot.

Methods

Method Modifiers Description
data(options) Retrieves all fields in the document as an Object. Returns undefined if the document doesn't exist.By default, FieldValue.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.
exists() Property of the DocumentSnapshot that signals whether or not the data exists. True if the document exists.
get(fieldPath, options) Retrieves the field specified by fieldPath. Returns undefined if the document or field doesn't exist.By default, a FieldValue.serverTimestamp() that has not yet been set to its final value will be returned as null. You can override this by passing an options object.