Class QuerySnapshot<T>

A wrapper around the Firestore QuerySnapshot class.

Type parameters

T: Entity

Hierarchy

QuerySnapshot

Implements

IQuerySnapshot<T>

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new QuerySnapshot(nativeSnapshot: QuerySnapshot, Entity: object, collection: ICollection<T>, query: Query<T>): QuerySnapshot

- Defined in QuerySnapshot.ts:30
Creates a query snapshot from firestore snapshot.

Parameters
- nativeSnapshot: QuerySnapshot
  
  The native query snapshot.
- Entity: object
  
  The entity to represention.
- collection: ICollection<T>
  
  The collection for the entity.
- query: Query<T>
  
  The query which was run.
Returns QuerySnapshot

Accessors

docs

get docs(): T[]

- Defined in QuerySnapshot.ts:55
The docs in the snapshot.

Returns T[]

empty

get empty(): boolean

- Defined in QuerySnapshot.ts:65
Whether or not the snapshot is empty.

Returns boolean

metadata

get metadata(): SnapshotMetadata

- Defined in QuerySnapshot.ts:70
The snapshot metadata.

Returns SnapshotMetadata

query

get query(): Query<T>

- Defined in QuerySnapshot.ts:75
The query which resulted in the snapshot.

Returns Query<T>

size

get size(): number

- Defined in QuerySnapshot.ts:60
The number of docs in the snapshot.

Returns number

Methods

docChanges

docChanges(opts?: firestore.SnapshotListenOptions): DocumentChange<T>[]

- Defined in QuerySnapshot.ts:89
Returns an array of the document changes since the last snapshot.

Parameters
- Optional opts: firestore.SnapshotListenOptions
  
  Options to control what type of changes to include in the results.
Returns DocumentChange<T>[]

forEach

forEach(callback: function): void

- Defined in QuerySnapshot.ts:81
Executes a callback function on the snapshot docs.

Parameters
- callback: function
  
  The function to run on each doc.
  - - (doc: T, index: number): void
    - Parameters
      - doc: T
      - index: number
      Returns void
Returns void

Generated using TypeDoc