The DocumentSnapshot
instance.
True if the document exists.
The ID of the document for which this GeoDocumentSnapshot
contains data.
The native DocumentSnapshot
instance.
A GeoDocumentReference
to the document location.
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 if you're on web.
Available on web only. An options object to configure how data is retrieved from the snapshot (e.g. the desired behavior for server timestamps that have not yet been set to their final value). (WEB ONLY)
An Object containing all fields in the document or 'undefined' if the document doesn't exist.
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.
The path (e.g. 'foo' or 'foo.bar') to a specific field.
An options object to configure how the field is retrieved from the snapshot (e.g. the desired behavior for server timestamps that have not yet been set to their final value). (WEB ONLY)
The data at the specified field location or undefined if no such field exists in the document.
Returns true if this DocumentSnapshot
or GeoDocumentSnapshot
is equal to the provided one.
The DocumentSnapshot
or GeoDocumentSnapshot
to compare against.
true if this GeoDocumentSnapshot
is equal to the provided one.
Generated using TypeDoc
A
GeoDocumentSnapshot
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
GeoDocumentSnapshot
that points to a non-existing document, any data access will return 'undefined'. You can use theexists
property to explicitly verify a document's existence.