QueryDocumentSnapshot

interface

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

Properties

exists

A QueryDocumentSnapshot is always guaranteed to exist.

exists: true;

id

Property of the DocumentSnapshot that provides the document's ID.

id: string;

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.

data(): { [key: string]: value };

get

Retrieves the field specified by fieldPath. Returns undefined if the document or field doesn't exist.

get(fieldPath: string | FieldPath): ;

isEqual

Returns true if this DocumentSnapshot is equal to the provided one.

isEqual(other: DocumentSnapshot): boolean;