Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DocumentSnapshot<T>

Type parameters

Hierarchy

  • DocumentSnapshot

Implements

Index

Constructors

Accessors

Constructors

constructor

  • Creates a document snapshot.

    Parameters

    • nativeSnapshot: DocumentSnapshot

      The firestore DocumentSnapshot.

    • Entity: object

      The entity to represent.

    • collection: ICollection<T>

      The parent collection for the entity.

    Returns DocumentSnapshot

Accessors

doc

  • get doc(): T

  • The document in the snapshot.

    Returns T

exists

  • get exists(): boolean

  • Whether or not the document exists.

    Returns boolean

metadata

  • get metadata(): SnapshotMetadata

  • The metadata for the reference.

    Returns SnapshotMetadata

ref

  • The document reference.

    Returns IDocumentRef<T>

Generated using TypeDoc