Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryDocumentSnapshot<T>

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

Type parameters

Hierarchy

  • QueryDocumentSnapshot

Index

Properties

Properties

data

data: () => T

Retrieves all fields in the document as an Object.

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.

returns

An Object containing all fields in the document.

Type declaration

    • (): T
    • Returns T

distance

distance: number

Distance in Km from center of geoquery.

exists

exists: boolean

Property of the DocumentSnapshot that signals whether or not the data exists. True if the document exists.

id

id: string

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

Generated using TypeDoc