DocumentSnapshot
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 property to explicitly verify a document's existence.
Properties
exists
</>Property of the DocumentSnapshot that signals whether or not the data exists. True if the document exists.
exists: boolean;
metadata
</>Metadata about the DocumentSnapshot, including information about its source and local modifications.
metadata: SnapshotMetadata;
ref
</>The DocumentReference for the document included in the DocumentSnapshot.
ref: DocumentReference<>;
Methods
data
</>Retrieves all fields in the document as an Object. Returns 'undefined' if the document doesn't exist.
data(): | undefined;
get
</>Retrieves the field specified by fieldPath. Returns undefined if the document or field doesn't exist.
get(fieldPath: | FieldPath): ;
isEqual
</>Returns true if this DocumentSnapshot is equal to the provided one.
isEqual(other: DocumentSnapshot): boolean;
