Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GeoDocumentSnapshot

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 the exists property to explicitly verify a document's existence.

Hierarchy

  • GeoDocumentSnapshot

Index

Constructors

Properties

Accessors

Methods

Constructors

Properties

_isWeb: boolean

Accessors

  • get exists(): boolean
  • get id(): string

Methods

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

    Parameters

    • Optional options: SnapshotOptions

      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)

    Returns GeoDocumentData

    An Object containing all fields in the document or 'undefined' if the document doesn't exist.

  • get(fieldPath: string | FieldPath | FieldPath, options?: SnapshotOptions): any
  • 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.

    Parameters

    • fieldPath: string | FieldPath | FieldPath

      The path (e.g. 'foo' or 'foo.bar') to a specific field.

    • Optional options: SnapshotOptions

      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)

    Returns any

    The data at the specified field location or undefined if no such field exists in the document.

Generated using TypeDoc